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

package/src/View/FormatColumn/Wizard/FormatColumnFormatWizardSection.js

@@ -388,11 +388,11 @@ const renderStringFormat = (data, _onChange, setFormatOption, scopedCustomFormat
                     ] })))));
 };
 const FormatColumnFormatWizardSection = (props) => {
-    var _a, _b, _c;
+    var _a;
     const { data } = (0, OnePageAdaptableWizard_1.useOnePageAdaptableWizardContext)();
     const adaptable = (0, AdaptableContext_1.useAdaptable)();
     const formatColumnApi = adaptable.api.formatColumnApi;
-    const customDisplayFormatters = (_c = (_b = (_a = adaptable.adaptableOptions) === null || _a === void 0 ? void 0 : _a.userInterfaceOptions) === null || _b === void 0 ? void 0 : _b.customDisplayFormatters) !== null && _c !== void 0 ? _c : [];
+    const customDisplayFormatters = (_a = adaptable.api.optionsApi.getFormatColumnOptions().customDisplayFormatters) !== null && _a !== void 0 ? _a : [];
     const update = (updated) => {
         props.onChange(Object.assign(Object.assign({}, data), updated));
     };

package/src/View/QuickSearch/QuickSearchPopup.js

@@ -18,7 +18,7 @@ const useQuickSearchDebounced_1 = require("./useQuickSearchDebounced");
 const QuickSearchPopupComponent = (props) => {
     const [searchText, search] = (0, useQuickSearchDebounced_1.useQuickSearchDebounced)(props);
     const [state, setState] = (0, react_1.useState)({
-        RunQueryAfterQuickSearch: props.api.optionsApi.getSearchOptions().filterResultsAfterQuickSearch,
+        RunQueryAfterQuickSearch: props.api.optionsApi.getQuickSearchOptions().filterResultsAfterQuickSearch,
         EditedStyle: props.QuickSearchStyle,
     });
     const onUpdateStyle = (style) => {
@@ -27,14 +27,14 @@ const QuickSearchPopupComponent = (props) => {
     };
     const onQuickSearchBehaviourChange = (checked) => {
         setState(Object.assign(Object.assign({}, state), { RunQueryAfterQuickSearch: checked }));
-        props.api.optionsApi.getAdaptableOptions().searchOptions.filterResultsAfterQuickSearch =
+        props.api.optionsApi.getAdaptableOptions().quickSearchOptions.filterResultsAfterQuickSearch =
             checked;
     };
     return (React.createElement(PopupPanel_1.PopupPanel, { headerText: props.moduleInfo.FriendlyName, glyphicon: props.moduleInfo.Glyph, infoLink: props.moduleInfo.HelpPage, infoLinkDisabled: !props.api.internalApi.isDocumentationLinksDisplayed() },
         React.createElement(Panel_1.default, { header: props.moduleInfo.FriendlyName + ' Text', style: { height: 'auto' }, variant: "default", borderRadius: "none", marginTop: 3, marginLeft: 2, marginRight: 2 },
             ' ',
             React.createElement(FormLayout_1.default, null,
-                React.createElement(AdaptableFormControlTextClear_1.AdaptableFormControlTextClear, { "data-name": "quick-search-text", type: "text", marginLeft: 2, marginRight: 5, padding: 20, style: { height: '100%' }, placeholder: props.api.optionsApi.getSearchOptions().quickSearchPlaceholder, value: searchText, OnTextChange: search }))),
+                React.createElement(AdaptableFormControlTextClear_1.AdaptableFormControlTextClear, { "data-name": "quick-search-text", type: "text", marginLeft: 2, marginRight: 5, padding: 20, style: { height: '100%' }, placeholder: props.api.optionsApi.getQuickSearchOptions().quickSearchPlaceholder, value: searchText, OnTextChange: search }))),
         React.createElement(Panel_1.default, { header: props.api.internalApi.getCorrectEnglishVariant('Behaviour'), style: { height: 'auto' }, variant: "default", borderRadius: "none", marginTop: 3, marginLeft: 2, marginRight: 2 },
             ' ',
             React.createElement(rebass_1.Flex, { flexDirection: "column" },

package/src/View/QuickSearch/QuickSearchStatusBarContent.js

@@ -12,6 +12,6 @@ const QuickSearchStatusBarContent = () => {
     const dispatch = (0, react_redux_1.useDispatch)();
     const adaptable = (0, AdaptableContext_1.useAdaptable)();
     const handleTextChange = React.useCallback((text) => dispatch(QuickSearchRedux.QuickSearchRun(text)), []);
-    return (React.createElement(AdaptableFormControlTextClear_1.AdaptableFormControlTextClear, { onClick: (event) => event.stopPropagation(), type: "text", inputStyle: { padding: '2px 3px', width: 90 }, placeholder: adaptable.api.optionsApi.getSearchOptions().quickSearchPlaceholder, value: text, OnTextChange: handleTextChange }));
+    return (React.createElement(AdaptableFormControlTextClear_1.AdaptableFormControlTextClear, { onClick: (event) => event.stopPropagation(), type: "text", inputStyle: { padding: '2px 3px', width: 90 }, placeholder: adaptable.api.optionsApi.getQuickSearchOptions().quickSearchPlaceholder, value: text, OnTextChange: handleTextChange }));
 };
 exports.QuickSearchStatusBarContent = QuickSearchStatusBarContent;

package/src/View/QuickSearch/QuickSearchViewPanel.js

@@ -10,7 +10,7 @@ const React = tslib_1.__importStar(require("react"));
 const QuickSearchViewPanelComponent = (props) => {
     const [searchText, search] = (0, useQuickSearchDebounced_1.useQuickSearchDebounced)(props);
     const elementType = props.viewType === 'Toolbar' ? 'DashboardToolbar' : 'ToolPanel';
-    return (React.createElement(AdaptableFormControlTextClear_1.AdaptableFormControlTextClear, { type: "text", placeholder: props.api.optionsApi.getSearchOptions().quickSearchPlaceholder, className: `ab-${elementType}__QuickSearch__text`, value: searchText, OnTextChange: search, style: { height: '100%' }, inputStyle: { width: '7rem' } }));
+    return (React.createElement(AdaptableFormControlTextClear_1.AdaptableFormControlTextClear, { type: "text", placeholder: props.api.optionsApi.getQuickSearchOptions().quickSearchPlaceholder, className: `ab-${elementType}__QuickSearch__text`, value: searchText, OnTextChange: search, style: { height: '100%' }, inputStyle: { width: '7rem' } }));
 };
 function mapStateToProps(state) {
     return {

package/src/agGrid/Adaptable.d.ts

@@ -1,6 +1,6 @@
 import { ChartRef, ColDef, ColGroupDef, Column, ColumnRowGroupChangedEvent, ExcelStyle, GridOptions, IRowNode, Module, ModuleNames } from '@ag-grid-community/core';
 import { AdaptableNoCodeWizardOptions, IAdaptableNoCodeWizard } from '../AdaptableInterfaces/AdaptableNoCodeWizard';
-import { AdaptableVariant, IAdaptable } from '../AdaptableInterfaces/IAdaptable';
+import { AdaptableVariant, AgGridConfig, IAdaptable } from '../AdaptableInterfaces/IAdaptable';
 import { AdaptableOptions } from '../AdaptableOptions/AdaptableOptions';
 import { AdaptablePlugin } from '../AdaptableOptions/AdaptablePlugin';
 import { AdaptableApi } from '../Api/AdaptableApi';
@@ -39,6 +39,7 @@ import { IRowEditService } from '../Utilities/Services/Interface/IRowEditService
 import { RenderReactRootFn } from '../renderReactRoot';
 import { AdaptableLogger } from './AdaptableLogger';
 declare type RuntimeConfig = {
+    gridOptions: GridOptions;
     waitForAgGrid?: boolean;
     supressReact18RenderWarning?: boolean;
     renderReactRoot?: RenderReactRootFn;
@@ -118,21 +119,19 @@ export declare class Adaptable implements IAdaptable {
      * @param runtimeConfig the list of all the provided AG Grid modules (which will be passed to the underlying AG Grid instance)
      * @returns a Promise containing the AdaptableAPI object in order to enable run-time access to Adaptable's properties and functions
      */
-    static init(adaptableOptions: AdaptableOptions, runtimeConfig: {
-        agGridModules: Module[];
-    }): Promise<AdaptableApi>;
+    static init(adaptableOptions: AdaptableOptions, agGridConfig: AgGridConfig): Promise<AdaptableApi>;
     /**
      * Lazy static constructor for Adaptable
      * Receives an AdaptableOptions object
      * Returns a Promise containing the AdaptableAPI object in order to enable run-time access to Adaptable's properties and functions
      * @param adaptableOptions an instance of AdaptableOptions
      */
-    static initInternal(adaptableOptions: AdaptableOptions, runtimeConfig?: RuntimeConfig): Promise<AdaptableApi>;
+    static initInternal(adaptableOptions: AdaptableOptions, runtimeConfig: RuntimeConfig): Promise<AdaptableApi>;
     private static collectInstance;
     static forEachAdaptable(fn: (adaptable: Adaptable) => void): void;
     private static dismissInstance;
     constructor();
-    init(adaptableOptions: AdaptableOptions, runtimeConfig?: RuntimeConfig, _staticInit?: boolean): Promise<AdaptableApi>;
+    init(adaptableOptions: AdaptableOptions, runtimeConfig: RuntimeConfig, _staticInit?: boolean): Promise<AdaptableApi>;
     forPlugins(callback: (plugin: AdaptablePlugin) => any): void;
     getPlugin(pluginId: string): AdaptablePlugin;
     getPluginProperty(pluginId: string, propertyName: string, ...args: any): any;
@@ -328,7 +327,8 @@ export declare class Adaptable implements IAdaptable {
     private applyCurrentTheme;
     private applyFinalRendering;
     isAgGridModulePresent(moduleName: ModuleNames): boolean;
-    private getAgGridRegisteredModules;
+    getAgGridRegisteredModules(): Module[];
+    private getAgGridRegisteredModuleNames;
     private onRowDataChanged;
     private onCellDataChanged;
     private isUndoChange;

package/src/agGrid/Adaptable.js

@@ -282,14 +282,15 @@ class Adaptable {
      * @param runtimeConfig the list of all the provided AG Grid modules (which will be passed to the underlying AG Grid instance)
      * @returns a Promise containing the AdaptableAPI object in order to enable run-time access to Adaptable's properties and functions
      */
-    static init(adaptableOptions, runtimeConfig) {
+    static init(adaptableOptions, agGridConfig) {
         var _a;
-        if (!((_a = runtimeConfig === null || runtimeConfig === void 0 ? void 0 : runtimeConfig.agGridModules) === null || _a === void 0 ? void 0 : _a.length)) {
+        if (!((_a = agGridConfig === null || agGridConfig === void 0 ? void 0 : agGridConfig.modules) === null || _a === void 0 ? void 0 : _a.length)) {
             AdaptableLogger_1.AdaptableLogger.consoleErrorBase(`No AG Grid modules were provided, thus limiting AdapTables features significantly!\n\nRead further info here:${DocumentationLinkConstants_1.AgGridModulesDocsLink}`);
         }
         return Adaptable.initInternal(adaptableOptions, {
+            gridOptions: agGridConfig.gridOptions,
             supressReact18RenderWarning: true,
-            agGridModules: runtimeConfig.agGridModules,
+            agGridModules: agGridConfig.modules,
         });
     }
     /**
@@ -354,29 +355,27 @@ class Adaptable {
     async init(adaptableOptions, runtimeConfig, _staticInit) {
         this.logger = new AdaptableLogger_1.AdaptableLogger(adaptableOptions.adaptableId || String(Date.now()));
         const perfAdaptableInit = this.logger.beginPerf(`Adaptable init()`);
-        if (runtimeConfig) {
-            this.supressReact18RenderWarning = !!runtimeConfig.supressReact18RenderWarning;
-            if (runtimeConfig.renderReactRoot) {
-                this.renderReactRoot = (el, container) => {
-                    const unmount = runtimeConfig.renderReactRoot(el, container);
-                    return () => {
-                        // we used to capture here because of FloatingFilters/Filters - see FloatingFilterWrapper and FilterWrapper
-                        // as we didn't have a native React implementation for our React wrapper
-                        // but we might need to do this again in the future for some other components that are not native React
-                        // captureReactWarnings();
-                        if (typeof unmount === 'function') {
-                            // rAF is required, otherwise the unmount would be performed during the rendering phase and React doesn't like that
-                            requestAnimationFrame(() => {
-                                unmount();
-                            });
-                        }
-                        // releaseReactWarnings();
-                    };
+        this.supressReact18RenderWarning = !!runtimeConfig.supressReact18RenderWarning;
+        if (runtimeConfig.renderReactRoot) {
+            this.renderReactRoot = (el, container) => {
+                const unmount = runtimeConfig.renderReactRoot(el, container);
+                return () => {
+                    // we used to capture here because of FloatingFilters/Filters - see FloatingFilterWrapper and FilterWrapper
+                    // as we didn't have a native React implementation for our React wrapper
+                    // but we might need to do this again in the future for some other components that are not native React
+                    // captureReactWarnings();
+                    if (typeof unmount === 'function') {
+                        // rAF is required, otherwise the unmount would be performed during the rendering phase and React doesn't like that
+                        requestAnimationFrame(() => {
+                            unmount();
+                        });
+                    }
+                    // releaseReactWarnings();
                 };
-            }
-            if (runtimeConfig.variant) {
-                this.variant = runtimeConfig.variant;
-            }
+            };
+        }
+        if (runtimeConfig.variant) {
+            this.variant = runtimeConfig.variant;
         }
         if (!_staticInit) {
             this.logger.warn(`
@@ -387,8 +386,11 @@ class Adaptable {
 !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!`);
         }
         this.emitter = new Emitter_1.default();
+        this.runtimeConfig = runtimeConfig;
+        this.gridOptions = this.runtimeConfig.gridOptions;
         // we create AdaptableOptions by merging the values provided by the user with the defaults (where no value has been set)
         this.adaptableOptions = AdaptableHelper_1.default.assignAdaptableOptions(adaptableOptions);
+        this.adaptableOptions._gridOptions = this.gridOptions;
         if (this.hasAutogeneratedPrimaryKey()) {
             this.logger
                 .warn(`Autogenerated primary key (adaptableOptions.autogeneratedPrimaryKey = TRUE) should be used only as a last resort,
@@ -398,8 +400,6 @@ class Adaptable {
             this.adaptableOptions.primaryKey = GeneralConstants_1.AUTOGENERATED_PK_COLUMN;
         }
         Adaptable.collectInstance(this);
-        this.runtimeConfig = runtimeConfig || {};
-        this.gridOptions = this.adaptableOptions.gridOptions;
         if (this.gridOptions.allowContextMenuWithControlKey === undefined) {
             this.gridOptions.allowContextMenuWithControlKey = true;
         }
@@ -444,6 +444,8 @@ class Adaptable {
         // @ts-ignore
         this.RowEditService = new RowEditService_1.RowEditService(this.api);
         this.MetamodelService = new MetamodelService_1.MetamodelService(() => this.api.optionsApi.getAdaptableOptions());
+        // validate the provided AdaptableOptions
+        this.MetamodelService.validateAdaptableOptionsValues();
         this.forPlugins((plugin) => plugin.afterInitServices(this));
         // Set up Modules - we set up all the Modules suitable for AG Grid
         // But users can make some hidden or readonly in their entitlements
@@ -463,15 +465,13 @@ class Adaptable {
             this.gridOptions.columnTypes.abColDefDate.cellEditor =
                 this.variant === 'react' ? AdaptableDateEditor_1.ReactAdaptableDateEditor : AdaptableDateEditor_1.AdaptableDateEditor;
         }
-        // validate the provided AdaptableOptions
-        this.MetamodelService.validateAdaptableOptionsValues();
         return this.initializeAgGrid().then((initialized) => {
             if (!initialized) {
                 // we have no grid, we can't do anything
                 this.logger.error('Unable to set up AG Grid');
                 return this.api;
             }
-            this.logger.info(`Registered AG Grid modules: `, this.getAgGridRegisteredModules().sort());
+            this.logger.info(`Registered AG Grid modules: `, this.getAgGridRegisteredModuleNames().sort());
             let self = this;
             // add our adaptable object to the grid options api object
             // this is VERY useful for when we need to access Adaptable inside of agGrid only functions
@@ -584,7 +584,7 @@ class Adaptable {
                 this.logger.info('emit AdaptableReady');
                 this.api.eventApi.emit('AdaptableReady', {
                     adaptableApi: this.api,
-                    gridOptions: this.adaptableOptions.gridOptions,
+                    gridOptions: this.gridOptions,
                 });
                 // }, 0);
                 perfInitState.end();
@@ -1256,7 +1256,7 @@ class Adaptable {
         if (!params.node) {
             return false;
         }
-        if (!this.api.optionsApi.getSearchOptions().runQuickSearchOnRowGroups && params.node.group) {
+        if (!this.api.optionsApi.getQuickSearchOptions().runQuickSearchOnRowGroups && params.node.group) {
             return false;
         }
         let quickSearchValue = this.api.quickSearchApi.getQuickSearchValue();
@@ -3781,6 +3781,9 @@ class Adaptable {
         return !!allGridModulesMap[moduleName];
     }
     getAgGridRegisteredModules() {
+        return core_1.ModuleRegistry.__getRegisteredModules(this.gridOptions.gridId);
+    }
+    getAgGridRegisteredModuleNames() {
         return core_1.ModuleRegistry.__getRegisteredModules(this.gridOptions.gridId).map((module) => module.moduleName);
     }
     onRowDataChanged({ rowNode, oldData, newData, }) {
@@ -5133,13 +5136,12 @@ class AdaptableNoCodeWizard {
     constructor(adaptableOptions, extraOptions = {}) {
         var _a;
         const defaultInit = async ({ gridOptions, adaptableOptions, agGridModules, }) => {
-            adaptableOptions.gridOptions = gridOptions;
-            return await Adaptable.init(adaptableOptions, { agGridModules: agGridModules });
+            return await Adaptable.init(adaptableOptions, { gridOptions, modules: agGridModules });
         };
         this.adaptableOptions = adaptableOptions;
         this.init = extraOptions.onInit || defaultInit;
         this.extraOptions = extraOptions;
-        this.agGridModules = core_1.ModuleRegistry.__getRegisteredModules((_a = this.adaptableOptions.gridOptions) === null || _a === void 0 ? void 0 : _a.gridId);
+        this.agGridModules = core_1.ModuleRegistry.__getRegisteredModules((_a = this.adaptableOptions._gridOptions) === null || _a === void 0 ? void 0 : _a.gridId);
         this.render();
     }
     render(container) {
@@ -5168,7 +5170,7 @@ class AdaptableNoCodeWizard {
                 unmount();
                 this.init({
                     adaptableOptions,
-                    gridOptions: adaptableOptions.gridOptions,
+                    gridOptions: adaptableOptions._gridOptions,
                     agGridModules: [...this.agGridModules],
                 });
             } })), container, true);

package/src/agGrid/agGridHelper.js

@@ -221,7 +221,7 @@ class agGridHelper {
             }
         }
         // lets set this here one as the function cannot change the result so dont need to run it each time
-        let excludeColumnFromQuickSearch = this.adaptable.adaptableOptions.searchOptions.excludeColumnFromQuickSearch;
+        let excludeColumnFromQuickSearch = this.adaptable.adaptableOptions.quickSearchOptions.excludeColumnFromQuickSearch;
         if (excludeColumnFromQuickSearch) {
             if (excludeColumnFromQuickSearch(abColumn)) {
                 abColumn.isExcludedFromQuickSearch = true;
@@ -540,7 +540,7 @@ class agGridHelper {
             }
         }
         // if they have selected to clear searches on startup then do it
-        if (this.adaptable.adaptableOptions.searchOptions.clearSearchesOnStartUp) {
+        if (this.adaptable.adaptableOptions.quickSearchOptions.clearSearchesOnStartUp) {
             if (StringExtensions_1.StringExtensions.IsNotNullOrEmpty(this.adaptable.api.quickSearchApi.getQuickSearchState().QuickSearchText) ||
                 StringExtensions_1.StringExtensions.IsNotNullOrEmpty(this.adaptable.api.queryApi.getCurrentQuery()) ||
                 ArrayExtensions_1.ArrayExtensions.IsNotNullOrEmpty(this.adaptable.api.dataSetApi.getDataSets())) {

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

@@ -964,6 +964,22 @@ export declare const ADAPTABLE_METAMODEL: {
         kind: string;
         desc: string;
     };
+    AgGridConfig: {
+        name: string;
+        kind: string;
+        desc: string;
+        props: ({
+            name: string;
+            kind: string;
+            desc: string;
+            ref: string;
+        } | {
+            name: string;
+            kind: string;
+            desc: string;
+            ref?: undefined;
+        })[];
+    };
     AlertButton: {
         name: string;
         kind: string;
@@ -2975,6 +2991,17 @@ export declare const ADAPTABLE_METAMODEL: {
             defVal?: undefined;
         })[];
     };
+    FormatColumnOptions: {
+        name: string;
+        kind: string;
+        desc: string;
+        props: {
+            name: string;
+            kind: string;
+            desc: string;
+            isOpt: boolean;
+        }[];
+    };
     FormatColumnPredicate: {
         name: string;
         kind: string;
@@ -3986,6 +4013,36 @@ export declare const ADAPTABLE_METAMODEL: {
             isOpt: boolean;
         }[];
     };
+    QuickSearchOptions: {
+        name: string;
+        kind: string;
+        desc: string;
+        props: ({
+            name: string;
+            kind: string;
+            desc: string;
+            isOpt: boolean;
+            gridInfo: string;
+            defVal: string;
+            noCode?: undefined;
+        } | {
+            name: string;
+            kind: string;
+            desc: string;
+            isOpt: boolean;
+            defVal: string;
+            gridInfo?: undefined;
+            noCode?: undefined;
+        } | {
+            name: string;
+            kind: string;
+            desc: string;
+            isOpt: boolean;
+            gridInfo: string;
+            noCode: string;
+            defVal: string;
+        })[];
+    };
     QuickSearchState: {
         name: string;
         kind: string;
@@ -4215,36 +4272,6 @@ export declare const ADAPTABLE_METAMODEL: {
             isOpt: boolean;
         }[];
     };
-    SearchOptions: {
-        name: string;
-        kind: string;
-        desc: string;
-        props: ({
-            name: string;
-            kind: string;
-            desc: string;
-            isOpt: boolean;
-            gridInfo: string;
-            defVal: string;
-            noCode?: undefined;
-        } | {
-            name: string;
-            kind: string;
-            desc: string;
-            isOpt: boolean;
-            defVal: string;
-            gridInfo?: undefined;
-            noCode?: undefined;
-        } | {
-            name: string;
-            kind: string;
-            desc: string;
-            isOpt: boolean;
-            gridInfo: string;
-            noCode: string;
-            defVal: string;
-        })[];
-    };
     SelectedCellInfo: {
         name: string;
         kind: string;