@adaptabletools/adaptable 14.0.0-canary.0 → 14.0.0-canary.1

package/src/Api/Implementation/ConfigApiImpl.js

@@ -12,7 +12,6 @@ const AlertRedux = tslib_1.__importStar(require("../../Redux/ActionsReducers/Ale
 const BulkUpdateRedux = tslib_1.__importStar(require("../../Redux/ActionsReducers/BulkUpdateRedux"));
 const CalculatedColumnRedux = tslib_1.__importStar(require("../../Redux/ActionsReducers/CalculatedColumnRedux"));
 const ChartingRedux = tslib_1.__importStar(require("../../Redux/ActionsReducers/ChartingRedux"));
-const ConditionalStyleRedux = tslib_1.__importStar(require("../../Redux/ActionsReducers/ConditionalStyleRedux"));
 const CustomSortRedux = tslib_1.__importStar(require("../../Redux/ActionsReducers/CustomSortRedux"));
 const ExportRedux = tslib_1.__importStar(require("../../Redux/ActionsReducers/ExportRedux"));
 const FormatColumnRedux = tslib_1.__importStar(require("../../Redux/ActionsReducers/FormatColumnRedux"));
@@ -110,7 +109,7 @@ class ConfigApiImpl extends ApiBase_1.ApiBase {
     getAdaptableSortState() {
         const adaptableSortState = {
             columnSorts: this.adaptable.api.gridApi.getColumnSorts(),
-            customSorts: this.adaptable.api.customSortApi.getAllCustomSort(),
+            customSorts: this.adaptable.api.customSortApi.getCustomSorts(),
         };
         return adaptableSortState;
     }
@@ -170,10 +169,6 @@ class ConfigApiImpl extends ApiBase_1.ApiBase {
                 return returnJson
                     ? JSON.stringify(this.getAdaptableState().Charting)
                     : this.getAdaptableState().Charting;
-            case 'ConditionalStyle':
-                return returnJson
-                    ? JSON.stringify(this.getAdaptableState().ConditionalStyle)
-                    : this.getAdaptableState().ConditionalStyle;
             case 'CustomSort':
                 return returnJson
                     ? JSON.stringify(this.getAdaptableState().CustomSort)
@@ -250,9 +245,6 @@ class ConfigApiImpl extends ApiBase_1.ApiBase {
     getChartingState(returnJson = false) {
         return this.getUserStateByStateKey('Charting', returnJson);
     }
-    getConditionalStyleState(returnJson = false) {
-        return this.getUserStateByStateKey('ConditionalStyle', returnJson);
-    }
     getCustomSortState(returnJson = false) {
         return this.getUserStateByStateKey('CustomSort', returnJson);
     }
@@ -306,9 +298,6 @@ class ConfigApiImpl extends ApiBase_1.ApiBase {
             case 'Charting':
                 this.dispatchAction(ChartingRedux.ChartingReady(this.getChartingState()));
                 break;
-            case 'ConditionalStyle':
-                this.dispatchAction(ConditionalStyleRedux.ConditionalStyleReady(this.getConditionalStyleState()));
-                break;
             case 'CustomSort':
                 this.dispatchAction(CustomSortRedux.CustomSortReady(this.getCustomSortState()));
                 break;

package/src/Api/Implementation/CustomSortApiImpl.d.ts

@@ -1,13 +1,27 @@
 import { ApiBase, LayoutAssociatedObjectLoadConfig } from './ApiBase';
 import { CustomSortApi } from '../CustomSortApi';
-import { CustomSortState, CustomSort } from '../../PredefinedConfig/CustomSortState';
+import { CustomSort, CustomSortState } from '../../PredefinedConfig/CustomSortState';
+import { IAdaptable } from '../../AdaptableInterfaces/IAdaptable';
+import { CustomSortInternalApi } from '../Internal/CustomSortInternalApi';
 export declare class CustomSortApiImpl extends ApiBase implements CustomSortApi {
+    internalApi: CustomSortInternalApi;
+    constructor(adaptable: IAdaptable);
     getCustomSortState(): CustomSortState;
     getAllCustomSort(config?: LayoutAssociatedObjectLoadConfig): CustomSort[];
+    getCustomSorts(config?: {
+        includeLayoutNotAssociatedObjects?: boolean;
+    }): CustomSort[];
     getCustomSortById(id: CustomSort['Uuid']): CustomSort;
     getAllActiveCustomSort(): CustomSort[];
+    getActiveCustomSorts(config?: {
+        includeLayoutNotAssociatedObjects?: boolean;
+    }): CustomSort[];
     getAllSuspendedCustomSort(): CustomSort[];
+    getSuspendedCustomSorts(config?: {
+        includeLayoutNotAssociatedObjects?: boolean;
+    }): CustomSort[];
     getCustomSortByColumn(column: string): CustomSort;
+    getCustomSortForColumn(columnId: string): CustomSort | undefined;
     addCustomSort(customSort: CustomSort): CustomSort;
     createCustomSort(columnId: string, values: string[]): CustomSort;
     editCustomSort(columnId: string, values: string[]): CustomSort;
@@ -15,4 +29,5 @@ export declare class CustomSortApiImpl extends ApiBase implements CustomSortApi
     suspendCustomSort(customSort: CustomSort): CustomSort;
     unSuspendCustomSort(customSort: CustomSort): CustomSort;
     showCustomSortPopup(): void;
+    openCustomSortSettingsPanel(): void;
 }

package/src/Api/Implementation/CustomSortApiImpl.js

@@ -5,25 +5,47 @@ const tslib_1 = require("tslib");
 const ModuleConstants = tslib_1.__importStar(require("../../Utilities/Constants/ModuleConstants"));
 const CustomSortRedux = tslib_1.__importStar(require("../../Redux/ActionsReducers/CustomSortRedux"));
 const ApiBase_1 = require("./ApiBase");
+const LoggingHelper_1 = require("../../Utilities/Helpers/LoggingHelper");
+const logDeprecation_1 = require("../../Utilities/logDeprecation");
+const CustomSortInternalApi_1 = require("../Internal/CustomSortInternalApi");
 class CustomSortApiImpl extends ApiBase_1.ApiBase {
+    constructor(adaptable) {
+        super(adaptable);
+        this.internalApi = new CustomSortInternalApi_1.CustomSortInternalApi(adaptable);
+    }
     getCustomSortState() {
         return this.getAdaptableState().CustomSort;
     }
     getAllCustomSort(config) {
+        (0, logDeprecation_1.logDeprecation)('CustomSortApi', 'getAllCustomSort', 'getCustomSorts');
+        return this.getCustomSorts(config);
+    }
+    getCustomSorts(config) {
         var _a;
         return ((_a = this.handleLayoutAssociatedObjects(this.getCustomSortState().CustomSorts, 'CustomSort', config)) !== null && _a !== void 0 ? _a : []);
     }
     getCustomSortById(id) {
-        return this.getAllCustomSort().find((customSort) => customSort.Uuid === id);
+        return this.getCustomSorts().find((customSort) => customSort.Uuid === id);
     }
     getAllActiveCustomSort() {
-        return this.getAllCustomSort().filter((customSort) => !customSort.IsSuspended);
+        (0, logDeprecation_1.logDeprecation)('CustomSortApi', 'getAllActiveCustomSort', 'getActiveCustomSorts');
+        return this.getActiveCustomSorts();
+    }
+    getActiveCustomSorts(config) {
+        return this.getCustomSorts(config).filter((customSort) => !customSort.IsSuspended);
     }
     getAllSuspendedCustomSort() {
-        return this.getAllCustomSort().filter((customSort) => customSort.IsSuspended);
+        (0, logDeprecation_1.logDeprecation)('CustomSortApi', 'getAllSuspendedCustomSort', 'getSuspendedCustomSorts');
+        return this.getSuspendedCustomSorts();
+    }
+    getSuspendedCustomSorts(config) {
+        return this.getCustomSorts(config).filter((customSort) => customSort.IsSuspended);
     }
     getCustomSortByColumn(column) {
-        return this.getAllCustomSort().find((cs) => cs.ColumnId == column);
+        return this.getCustomSorts().find((cs) => cs.ColumnId == column);
+    }
+    getCustomSortForColumn(columnId) {
+        return this.getCustomSorts().find((cs) => cs.ColumnId == columnId);
     }
     addCustomSort(customSort) {
         this.addUidToAdaptableObject(customSort);
@@ -35,16 +57,17 @@ class CustomSortApiImpl extends ApiBase_1.ApiBase {
         return this.addCustomSort(customSort);
     }
     editCustomSort(columnId, values) {
-        const previousCustomSort = this.getCustomSortByColumn(columnId);
+        const previousCustomSort = this.getCustomSortForColumn(columnId);
         if (!previousCustomSort) {
-            throw new TypeError(`No custom sort defined for ${columnId}`);
+            (0, LoggingHelper_1.LogAdaptableWarning)(`No custom sort defined for ${columnId}`);
+            return;
         }
         const newCustomSort = Object.assign(Object.assign({}, previousCustomSort), { SortedValues: values });
         this.dispatchAction(CustomSortRedux.CustomSortEdit(newCustomSort));
         return this.getCustomSortByColumn(columnId);
     }
     deleteCustomSort(column) {
-        let customSort = this.getCustomSortByColumn(column);
+        let customSort = this.getCustomSortForColumn(column);
         this.dispatchAction(CustomSortRedux.CustomSortDelete(customSort));
     }
     suspendCustomSort(customSort) {
@@ -56,6 +79,9 @@ class CustomSortApiImpl extends ApiBase_1.ApiBase {
         return this.getCustomSortById(customSort.Uuid);
     }
     showCustomSortPopup() {
+        (0, logDeprecation_1.logDeprecation)('CustomSortApi', 'showCustomSortPopup', 'openCustomSortSettingsPanel');
+    }
+    openCustomSortSettingsPanel() {
         this.showModulePopup(ModuleConstants.CustomSortModuleId);
     }
 }

package/src/Api/Implementation/DashboardApiImpl.d.ts

@@ -1,12 +1,16 @@
 import { ApiBase } from './ApiBase';
 import { DashboardApi } from '../DashboardApi';
 import { DashboardState, DashboardTab } from '../../PredefinedConfig/DashboardState';
-import { AdaptableModuleButtons, AdaptableDashboardToolbars, AdaptableDashboardToolbar } from '../../PredefinedConfig/Common/Types';
+import { AdaptableDashboardToolbar, AdaptableDashboardToolbars, AdaptableModuleButtons } from '../../PredefinedConfig/Common/Types';
 import { DashboardChangedInfo } from '../Events/DashboardChanged';
 import { AdaptableButton } from '../../PredefinedConfig/Common/AdaptableButton';
 import { DashboardButtonContext } from '../../types';
 import { CustomToolbar } from '../../AdaptableOptions/DashboardOptions';
+import { IAdaptable } from '../../AdaptableInterfaces/IAdaptable';
+import { DashboardInternalApi } from '../Internal/DashboardInternalApi';
 export declare class DashboardApiImpl extends ApiBase implements DashboardApi {
+    internalApi: DashboardInternalApi;
+    constructor(adaptable: IAdaptable);
     getDashboardState(): DashboardState;
     getCustomToolbars(): CustomToolbar[];
     getCustomDashboardButtons(): AdaptableButton<DashboardButtonContext>[];
@@ -32,6 +36,7 @@ export declare class DashboardApiImpl extends ApiBase implements DashboardApi {
     getCurrentToolbars(): AdaptableDashboardToolbars | string[] | undefined;
     fireDashboardChangedEvent: (trigger: string, oldDashboardState: DashboardState, newDashboardState: DashboardState) => void;
     showDashboardPopup(): void;
+    openDashboardSettingsPanel(): void;
     hasCustomToolbarChanged(dashboardChangedInfo: DashboardChangedInfo, customToolbarName: string): 'hidden' | 'visible' | 'none';
     private isToolbarInActiveTab;
     isDashboardCollapsed(): boolean;

package/src/Api/Implementation/DashboardApiImpl.js

@@ -5,27 +5,21 @@ const tslib_1 = require("tslib");
 const DashboardRedux = tslib_1.__importStar(require("../../Redux/ActionsReducers/DashboardRedux"));
 const ApiBase_1 = require("./ApiBase");
 const ModuleConstants = tslib_1.__importStar(require("../../Utilities/Constants/ModuleConstants"));
-const isEqual_1 = tslib_1.__importDefault(require("lodash/isEqual"));
-const react_dom_1 = tslib_1.__importDefault(require("react-dom"));
-const react_1 = tslib_1.__importDefault(require("react"));
+const React = tslib_1.__importStar(require("react"));
 const SystemRedux_1 = require("../../Redux/ActionsReducers/SystemRedux");
+const DashboardInternalApi_1 = require("../Internal/DashboardInternalApi");
+const logDeprecation_1 = require("../../Utilities/logDeprecation");
 class DashboardApiImpl extends ApiBase_1.ApiBase {
-    constructor() {
-        super(...arguments);
+    constructor(adaptable) {
+        super(adaptable);
         // it's called synchronously by DASHBOARD_SET_ACTIVE_TAB & DASHBOARD_SET_IS_COLLAPSED,
         // both firing the same events, thus this function being called twice;
         // so we debounced to only get tha latest call
         this.fireDashboardChangedEvent = (trigger, oldDashboardState, newDashboardState) => {
-            const dashboardChangedInfo = {
-                adaptableApi: this.adaptable.api,
-                actionName: trigger,
-                oldDashboardState: oldDashboardState,
-                newDashboardState: newDashboardState,
-            };
-            if (!(0, isEqual_1.default)(oldDashboardState, newDashboardState)) {
-                this.adaptable.api.eventApi.emitSync('DashboardChanged', dashboardChangedInfo);
-            }
+            (0, logDeprecation_1.logDeprecationInternal)('DashboardApi', 'fireDashboardChangedEvent');
+            this.internalApi.fireDashboardChangedEvent(trigger, oldDashboardState, newDashboardState);
         };
+        this.internalApi = new DashboardInternalApi_1.DashboardInternalApi(adaptable);
     }
     getDashboardState() {
         return this.getAdaptableState().Dashboard;
@@ -63,7 +57,7 @@ class DashboardApiImpl extends ApiBase_1.ApiBase {
     setCustomToolbarContents(customToolbarName, contents) {
         let contentsDiv = this.getCustomToolbarContentsDiv(customToolbarName);
         if (contentsDiv) {
-            react_dom_1.default.render(react_1.default.createElement("div", { dangerouslySetInnerHTML: { __html: contents } }), contentsDiv);
+            this.adaptable.renderReactRoot(React.createElement("div", { dangerouslySetInnerHTML: { __html: contents } }), contentsDiv);
         }
     }
     getCustomToolbarByName(customToolbarName) {
@@ -125,6 +119,10 @@ class DashboardApiImpl extends ApiBase_1.ApiBase {
         return currentTab.Toolbars;
     }
     showDashboardPopup() {
+        (0, logDeprecation_1.logDeprecation)('DashboardApi', 'showDashboardPopup', 'openDashboardSettingsPanel');
+        this.openDashboardSettingsPanel();
+    }
+    openDashboardSettingsPanel() {
         this.showModulePopup(ModuleConstants.DashboardModuleId);
     }
     hasCustomToolbarChanged(dashboardChangedInfo, customToolbarName) {

package/src/Api/Implementation/DataChangeHistoryApiImpl.d.ts

@@ -9,4 +9,5 @@ export declare class DataChangeHistoryApiImpl extends ApiBase implements DataCha
     getDataChangeHistoryLog(): CellDataChangedInfo[];
     undoDataChangeHistoryEntry(dataChangeInfo: CellDataChangedInfo): void;
     showDataChangeHistoryPopup(): void;
+    openDataChangeHistorySettingsPanel(): void;
 }

package/src/Api/Implementation/DataChangeHistoryApiImpl.js

@@ -5,6 +5,7 @@ const tslib_1 = require("tslib");
 const ApiBase_1 = require("./ApiBase");
 const SystemRedux_1 = require("../../Redux/ActionsReducers/SystemRedux");
 const ModuleConstants = tslib_1.__importStar(require("../../Utilities/Constants/ModuleConstants"));
+const logDeprecation_1 = require("../../Utilities/logDeprecation");
 class DataChangeHistoryApiImpl extends ApiBase_1.ApiBase {
     getDataChangeHistoryMode() {
         return this.getAdaptableState().System.DataChangeHistory.currentMode;
@@ -41,6 +42,10 @@ class DataChangeHistoryApiImpl extends ApiBase_1.ApiBase {
         this.dispatchAction((0, SystemRedux_1.SystemDataChangeHistoryUndo)(dataChangeInfo));
     }
     showDataChangeHistoryPopup() {
+        (0, logDeprecation_1.logDeprecation)('DataChangeHistoryApi', 'showDataChangeHistoryPopup', 'openDataChangeHistorySettingsPanel');
+        this.openDataChangeHistorySettingsPanel();
+    }
+    openDataChangeHistorySettingsPanel() {
         this.showModulePopup(ModuleConstants.DataChangeHistoryModuleId);
     }
 }

package/src/Api/Implementation/DataSetApiImpl.d.ts

@@ -1,12 +1,18 @@
 import { ApiBase } from './ApiBase';
 import { DataSetApi } from '../DataSetApi';
 import { DataSet } from '../../AdaptableOptions/GeneralOptions';
+import { IAdaptable } from '../../AdaptableInterfaces/IAdaptable';
+import { DataSetInternalApi } from '../Internal/DataSetInternalApi';
 export declare class DataSetApiImpl extends ApiBase implements DataSetApi {
+    internalApi: DataSetInternalApi;
+    constructor(adaptable: IAdaptable);
     getAllDataSets(): DataSet[];
+    getDataSets(): DataSet[];
     getCurrentDataSet(): DataSet | undefined;
     getDataSetByName(dataSetName: string): DataSet | undefined;
     setDataSet(dataSetName: string): void;
     clearCurrentDataSet(): void;
     showDataSetPopup(): void;
+    openDataSetSettingsPanel(): void;
     fireDataSetSelectedEvent(dataSet: DataSet): void;
 }

package/src/Api/Implementation/DataSetApiImpl.js

@@ -5,8 +5,18 @@ const tslib_1 = require("tslib");
 const ModuleConstants = tslib_1.__importStar(require("../../Utilities/Constants/ModuleConstants"));
 const SystemRedux = tslib_1.__importStar(require("../../Redux/ActionsReducers/SystemRedux"));
 const ApiBase_1 = require("./ApiBase");
+const DataSetInternalApi_1 = require("../Internal/DataSetInternalApi");
+const logDeprecation_1 = require("../../Utilities/logDeprecation");
 class DataSetApiImpl extends ApiBase_1.ApiBase {
+    constructor(adaptable) {
+        super(adaptable);
+        this.internalApi = new DataSetInternalApi_1.DataSetInternalApi(adaptable);
+    }
     getAllDataSets() {
+        (0, logDeprecation_1.logDeprecation)('DataSetApi', 'getAllDataSets', 'getDataSets');
+        return this.getDataSets();
+    }
+    getDataSets() {
         var _a, _b, _c;
         return (_c = (_b = (_a = this.adaptable.adaptableOptions) === null || _a === void 0 ? void 0 : _a.generalOptions) === null || _b === void 0 ? void 0 : _b.dataSets) !== null && _c !== void 0 ? _c : [];
     }
@@ -15,7 +25,7 @@ class DataSetApiImpl extends ApiBase_1.ApiBase {
         return this.getDataSetByName(currentDataSetName);
     }
     getDataSetByName(dataSetName) {
-        return this.getAllDataSets().find((a) => a.name == dataSetName);
+        return this.getDataSets().find((a) => a.name == dataSetName);
     }
     setDataSet(dataSetName) {
         const dataSet = this.getDataSetByName(dataSetName);
@@ -27,16 +37,15 @@ class DataSetApiImpl extends ApiBase_1.ApiBase {
         this.dispatchAction(SystemRedux.SystemDataSetSelect(null));
     }
     showDataSetPopup() {
+        (0, logDeprecation_1.logDeprecation)('DataSetApi', 'showDataSetPopup', 'openDataSetSettingsPanel');
+        this.openDataSetSettingsPanel();
+    }
+    openDataSetSettingsPanel() {
         this.showModulePopup(ModuleConstants.DataSetModuleId);
     }
     fireDataSetSelectedEvent(dataSet) {
-        if (this.adaptable.isLive) {
-            const dataSetSelectedInfo = {
-                adaptableApi: this.adaptable.api,
-                dataSet,
-            };
-            this.adaptable.api.eventApi.emit('DataSetSelected', dataSetSelectedInfo);
-        }
+        (0, logDeprecation_1.logDeprecationInternal)('DataSetApi', 'fireDataSetSelectedEvent');
+        this.internalApi.fireDataSetSelectedEvent(dataSet);
     }
 }
 exports.DataSetApiImpl = DataSetApiImpl;

package/src/Api/Implementation/EntitlementApiImpl.d.ts

@@ -0,0 +1,11 @@
+import { ApiBase } from './ApiBase';
+import { EntitlementApi } from '../EntitlementApi';
+import { AccessLevel, AdaptableModule, AdaptableObject } from '../../types';
+export declare class EntitlementApiImpl extends ApiBase implements EntitlementApi {
+    private getEntitlementService;
+    getEntitlementAccessLevelForModule(adaptableModule: AdaptableModule): AccessLevel;
+    isObjectReadonly(object: AdaptableObject): boolean;
+    isModuleHiddenEntitlement(adaptableModule: AdaptableModule): boolean;
+    isModuleFullEntitlement(adaptableModule: AdaptableModule): boolean;
+    isModuleReadOnlyEntitlement(adaptableModule: AdaptableModule): boolean;
+}

package/src/Api/Implementation/EntitlementApiImpl.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EntitlementApiImpl = void 0;
+const ApiBase_1 = require("./ApiBase");
+class EntitlementApiImpl extends ApiBase_1.ApiBase {
+    getEntitlementService() {
+        return this.getAdaptableApi().internalApi.getEntitlementService();
+    }
+    getEntitlementAccessLevelForModule(adaptableModule) {
+        return this.getEntitlementService().getEntitlementAccessLevelForModule(adaptableModule);
+    }
+    isObjectReadonly(object) {
+        return object.IsReadOnly;
+    }
+    isModuleHiddenEntitlement(adaptableModule) {
+        return this.getEntitlementService().isModuleHiddenEntitlement(adaptableModule);
+    }
+    isModuleFullEntitlement(adaptableModule) {
+        return this.getEntitlementService().isModuleFullEntitlement(adaptableModule);
+    }
+    isModuleReadOnlyEntitlement(adaptableModule) {
+        return this.getEntitlementService().isModuleReadOnlyEntitlement(adaptableModule);
+    }
+}
+exports.EntitlementApiImpl = EntitlementApiImpl;

package/src/Api/Implementation/ExportApiImpl.d.ts

@@ -3,9 +3,13 @@ import { ExportState, Report, ReportData, ReportSchedule, SystemReportNames } fr
 import { ApiBase } from './ApiBase';
 import { AdaptableForm } from '../../PredefinedConfig/Common/AdaptableForm';
 import { CellDataChangedInfo } from '../../PredefinedConfig/Common/CellDataChangedInfo';
-import { CustomDestination, CustomReport, ExportFormContext } from '../../AdaptableOptions/ExportOptions';
+import { CustomDestination, ExportFormContext, ServerReport } from '../../AdaptableOptions/ExportOptions';
 import { ExportDestination } from '../../PredefinedConfig/Common/Enums';
+import { IAdaptable } from '../../AdaptableInterfaces/IAdaptable';
+import { ExportInternalApi } from '../Internal/ExportInternalApi';
 export declare class ExportApiImpl extends ApiBase implements ExportApi {
+    internalApi: ExportInternalApi;
+    constructor(adaptable: IAdaptable);
     getExportState(): ExportState;
     getCurrentReportName(): string;
     getCurrentReport(): Report;
@@ -16,22 +20,26 @@ export declare class ExportApiImpl extends ApiBase implements ExportApi {
     getAvailableSystemReports(): SystemReportNames;
     getAvailableExportDestinations(): ExportDestination[];
     getAllReports(): Report[];
+    getReports(): Report[];
     getReportSchedules(): ReportSchedule[];
     sendReport(reportName: string, destination: 'Excel' | 'CSV' | 'Clipboard' | 'JSON' | string): void;
     selectReport(reportName: string): void;
     selectDestination(destinationName: string): void;
     getAllCustomDestination(): CustomDestination[];
+    getCustomDestinations(): CustomDestination[];
     isExportDestinationCustom(destinationName: string): boolean;
     getExportDestinationForm(destinationName: string): AdaptableForm<ExportFormContext> | undefined;
     canExportToExcel(): boolean;
     exportDataToExcel(reportData: ReportData, fileName: string): void;
     showExportPopup(): void;
+    openExportSettingsPanel(): void;
     editReport(report: Report): Report;
     editReports(reports: Report[]): Report[];
     isDataChangeInReport(cellDataChangedInfo: CellDataChangedInfo, report: Report): boolean;
     exportVisualDataToExcel(): void;
-    getAllCustomReports(): CustomReport[] | undefined;
-    isCustomReport(report: Report): boolean;
-    runCustomReport(customReportName: string): ReportData | undefined;
+    getAllServerReports(): ServerReport[] | undefined;
+    getServerReports(): ServerReport[];
+    isServerReport(report: Report): boolean;
+    runServerReport(serverReportName: string): ReportData | undefined;
     getReportDataForReport(reportName: string): ReportData | undefined;
 }

package/src/Api/Implementation/ExportApiImpl.js

@@ -9,7 +9,13 @@ const Enums_1 = require("../../PredefinedConfig/Common/Enums");
 const LoggingHelper_1 = require("../../Utilities/Helpers/LoggingHelper");
 const ObjectFactory_1 = tslib_1.__importDefault(require("../../Utilities/ObjectFactory"));
 const ArrayExtensions_1 = tslib_1.__importDefault(require("../../Utilities/Extensions/ArrayExtensions"));
+const ExportInternalApi_1 = require("../Internal/ExportInternalApi");
+const logDeprecation_1 = require("../../Utilities/logDeprecation");
 class ExportApiImpl extends ApiBase_1.ApiBase {
+    constructor(adaptable) {
+        super(adaptable);
+        this.internalApi = new ExportInternalApi_1.ExportInternalApi(adaptable);
+    }
     getExportState() {
         return this.getAdaptableState().Export;
     }
@@ -26,18 +32,18 @@ class ExportApiImpl extends ApiBase_1.ApiBase {
             return this.adaptable.ReportService.CreateSystemReport(reportName);
         }
         else {
-            return this.getAllReports().find((r) => r.Name == reportName);
+            return this.getReports().find((r) => r.Name == reportName);
         }
     }
     getReportById(id) {
         var _a;
-        return (_a = this.getAllReports()) === null || _a === void 0 ? void 0 : _a.find((report) => report.Uuid === id);
+        return (_a = this.getReports()) === null || _a === void 0 ? void 0 : _a.find((report) => report.Uuid === id);
     }
     getDestinationByName(destinationName) {
         if (Object.values(Enums_1.ExportDestination).some((val) => val === destinationName)) {
             return destinationName;
         }
-        return this.getAllCustomDestination().find((destination) => destination.name === destinationName);
+        return this.getCustomDestinations().find((destination) => destination.name === destinationName);
     }
     getCurrentDestination() {
         const currentDestination = this.getExportState().CurrentDestination;
@@ -58,13 +64,17 @@ class ExportApiImpl extends ApiBase_1.ApiBase {
         return systemDestinations;
     }
     getAllReports() {
+        (0, logDeprecation_1.logDeprecation)('ExportApi', 'getAllReports', 'getReports');
+        return this.getReports();
+    }
+    getReports() {
         const reports = this.getAvailableSystemReports()
             .map((s) => this.getReportByName(s))
             .concat(this.getExportState().Reports);
-        const customReports = this.getAllCustomReports();
-        if (ArrayExtensions_1.default.IsNotNullOrEmpty(customReports)) {
-            reports.push(...customReports.map((c) => {
-                return ObjectFactory_1.default.CreateCustomReport(c.name);
+        const serverReports = this.getServerReports();
+        if (ArrayExtensions_1.default.IsNotNullOrEmpty(serverReports)) {
+            reports.push(...serverReports.map((c) => {
+                return ObjectFactory_1.default.CreateServerReport(c.name);
             }));
         }
         return reports;
@@ -85,15 +95,19 @@ class ExportApiImpl extends ApiBase_1.ApiBase {
         this.dispatchAction(ExportRedux.DestinationSelect(destinationName));
     }
     getAllCustomDestination() {
+        (0, logDeprecation_1.logDeprecation)('ExportApi', 'getAllCustomDestination', 'getCustomDestinations');
+        return this.getCustomDestinations();
+    }
+    getCustomDestinations() {
         var _a;
         return (_a = this.getExportOptions().customDestinations) !== null && _a !== void 0 ? _a : [];
     }
     isExportDestinationCustom(destinationName) {
-        return this.getAllCustomDestination().some((destination) => destination.name === destinationName);
+        return this.getCustomDestinations().some((destination) => destination.name === destinationName);
     }
     getExportDestinationForm(destinationName) {
         var _a;
-        return (_a = this.getAllCustomDestination().find((destination) => destination.name === destinationName)) === null || _a === void 0 ? void 0 : _a.form;
+        return (_a = this.getCustomDestinations().find((destination) => destination.name === destinationName)) === null || _a === void 0 ? void 0 : _a.form;
     }
     canExportToExcel() {
         return this.adaptable.canExportToExcel();
@@ -102,6 +116,10 @@ class ExportApiImpl extends ApiBase_1.ApiBase {
         this.adaptable.exportToExcel(reportData, fileName);
     }
     showExportPopup() {
+        (0, logDeprecation_1.logDeprecation)('ExportApi', 'showExportPopup', 'openExportSettingsPanel');
+        this.openExportSettingsPanel();
+    }
+    openExportSettingsPanel() {
         this.showModulePopup(ModuleConstants.ExportModuleId);
     }
     editReport(report) {
@@ -115,84 +133,32 @@ class ExportApiImpl extends ApiBase_1.ApiBase {
         return reports === null || reports === void 0 ? void 0 : reports.map((report) => this.getReportById(report.Uuid));
     }
     isDataChangeInReport(cellDataChangedInfo, report) {
-        // for All Data Report any data change is true so get out asap
-        if (report.Name == 'All Data') {
-            return true;
-        }
-        // if its a Custom Report then the User has to run it so we just ignore completely
-        if (this.isCustomReport(report)) {
-            return false;
-        }
-        // Start with the DataChanged Column and go through all possibilities
-        switch (report.ReportColumnScope) {
-            case 'AllColumns':
-                // has to be relevant so continue to rows
-                break;
-            case 'ScopeColumns':
-                // use the Scope object which will tell us if the Column is relevant
-                if (!this.adaptable.api.scopeApi.isColumnInScopeColumns(cellDataChangedInfo.column, report.Scope)) {
-                    return false;
-                }
-                break;
-            case 'SelectedColumns':
-                let selectedCellInfo = this.adaptable.api.gridApi.getSelectedCellInfo();
-                if (selectedCellInfo) {
-                    if (selectedCellInfo.columns.find((c) => c.columnId == cellDataChangedInfo.column.columnId) == null) {
-                        return false;
-                    }
-                }
-                break;
-            case 'VisibleColumns':
-                //  hope that visibile column property is updated whenever the layout changes... (need to check!)
-                if (!cellDataChangedInfo.column.visible) {
-                    return false;
-                }
-                break;
-        }
-        // now do rows
-        switch (report.ReportRowScope) {
-            case 'AllRows':
-                return true;
-            case 'ExpressionRows':
-                return true; // TODO this is the only difficult one - do we check AdapTableQL?  if we can then that is good as we can then do a delta after all...
-            case 'SelectedCellRows':
-                let selectedCellInfo = this.adaptable.api.gridApi.getSelectedCellInfo();
-                if (selectedCellInfo && selectedCellInfo.gridCells) {
-                    if (selectedCellInfo.gridCells.find((gc) => gc.primaryKeyValue == cellDataChangedInfo.primaryKeyValue)) {
-                        return true;
-                    }
-                }
-                return false;
-            case 'SelectedRows':
-                let selectedRowInfo = this.adaptable.api.gridApi.getSelectedRowInfo();
-                if (selectedRowInfo && selectedRowInfo.gridRows) {
-                    if (selectedRowInfo.gridRows.find((gr) => gr.primaryKeyValue == cellDataChangedInfo.primaryKeyValue)) {
-                        return true;
-                    }
-                }
-                return false;
-            case 'VisibleRows':
-                return this.adaptable.isRowNodeVisible(cellDataChangedInfo.rowNode);
-        }
+        (0, logDeprecation_1.logDeprecationInternal)('ExportApi', 'isDataChangeInReport');
+        return this.internalApi.isDataChangeInReport(cellDataChangedInfo, report);
     }
     exportVisualDataToExcel() {
         this.adaptable.exportVisualDataToExcel();
     }
-    getAllCustomReports() {
-        return this.getExportOptions().customReports;
+    getAllServerReports() {
+        (0, logDeprecation_1.logDeprecation)('ExportApi', 'getAllServerReports', 'getServerReports');
+        return this.getServerReports();
+    }
+    getServerReports() {
+        var _a;
+        return (_a = this.getExportOptions().serverReports) !== null && _a !== void 0 ? _a : [];
     }
-    isCustomReport(report) {
+    isServerReport(report) {
         var _a;
-        return ((_a = this.getAllCustomReports()) === null || _a === void 0 ? void 0 : _a.find((cr) => cr.name == report.Name)) != null;
+        return ((_a = this.getServerReports()) === null || _a === void 0 ? void 0 : _a.find((cr) => cr.name == report.Name)) != null;
     }
-    runCustomReport(customReportName) {
+    runServerReport(serverReportName) {
         var _a;
-        const customReport = (_a = this.getAllCustomReports()) === null || _a === void 0 ? void 0 : _a.find((cr) => cr.name == customReportName);
-        if (!customReport) {
-            (0, LoggingHelper_1.LogAdaptableWarning)(`Custom Report '${customReportName}' not found!`);
+        const serverReport = (_a = this.getServerReports()) === null || _a === void 0 ? void 0 : _a.find((cr) => cr.name == serverReportName);
+        if (!serverReport) {
+            (0, LoggingHelper_1.LogAdaptableWarning)(`Server Report '${serverReportName}' not found!`);
             return undefined;
         }
-        return customReport.onRunReport();
+        return serverReport.onRunReport();
     }
     getReportDataForReport(reportName) {
         const report = this.getReportByName(reportName);