@adaptabletools/adaptable 11.1.15 → 11.1.16

package/src/Api/Implementation/AlertApiImpl.js

@@ -21,20 +21,20 @@ class AlertApiImpl extends ApiBase_1.ApiBase {
         return (_a = alertForms.find((f) => f.name === name)) === null || _a === void 0 ? void 0 : _a.form;
     }
     getAlertDefinitions() {
-        return this.getAlertState().AlertDefinitions;
+        var _a, _b;
+        return ((_b = (_a = this.getAlertState().AlertDefinitions) === null || _a === void 0 ? void 0 : _a.filter((alertDefinition) => this.adaptable.api.internalApi.isObjectAvailableInLayout(alertDefinition, 'Alert'))) !== null && _b !== void 0 ? _b : []);
     }
     getAlertDefinitionById(id) {
-        var _a;
-        return (_a = this.getAlertDefinitions()) === null || _a === void 0 ? void 0 : _a.find((alert) => (alert === null || alert === void 0 ? void 0 : alert.Uuid) === id);
+        return this.getAlertDefinitions().find((alert) => (alert === null || alert === void 0 ? void 0 : alert.Uuid) === id);
     }
     getNonReactiveAlertDefinitions() {
-        return this.getAlertState().AlertDefinitions.filter((alertDef) => !AdaptableQuery_1.isReactiveQuery(alertDef.Rule));
+        return this.getAlertDefinitions().filter((alertDef) => !AdaptableQuery_1.isReactiveQuery(alertDef.Rule));
     }
     getActiveNonReactiveAlertDefinitions() {
         return this.getNonReactiveAlertDefinitions().filter((alertDef) => !alertDef.IsSuspended);
     }
     getReactiveAlertDefinitions() {
-        return this.getAlertState().AlertDefinitions.filter((alertDef) => AdaptableQuery_1.isReactiveQuery(alertDef.Rule));
+        return this.getAlertDefinitions().filter((alertDef) => AdaptableQuery_1.isReactiveQuery(alertDef.Rule));
     }
     getActiveReactiveAlertDefinitions() {
         return this.getReactiveAlertDefinitions().filter((alertDef) => !alertDef.IsSuspended);

package/src/Api/Implementation/ApiBase.js

@@ -42,6 +42,9 @@ class ApiBase {
      * @param action the Redux Action to be dispatched
      */
     dispatchAction(action) {
+        if (this.adaptable.isDestroyed) {
+            return;
+        }
         this.adaptable.adaptableStore.TheStore.dispatch(action);
     }
     /**

package/src/Api/Implementation/ConditionalStyleApiImpl.js

@@ -10,14 +10,14 @@ class ConditionalStyleApiImpl extends ApiBase_1.ApiBase {
         return this.getAdaptableState().ConditionalStyle;
     }
     getAllConditionalStyle() {
-        return this.getConditionalStyleState().ConditionalStyles;
+        var _a, _b;
+        return ((_b = (_a = this.getConditionalStyleState().ConditionalStyles) === null || _a === void 0 ? void 0 : _a.filter((conditionalStyle) => this.adaptable.api.internalApi.isObjectAvailableInLayout(conditionalStyle, 'ConditionalStyle'))) !== null && _b !== void 0 ? _b : []);
     }
     getAllActiveConditionalStyle() {
         return this.getAllConditionalStyle().filter((style) => !style.IsSuspended);
     }
     getConditionalStyleById(id) {
-        var _a;
-        return (_a = this.getAllConditionalStyle()) === null || _a === void 0 ? void 0 : _a.find((conditionalStyle) => (conditionalStyle === null || conditionalStyle === void 0 ? void 0 : conditionalStyle.Uuid) === id);
+        return this.getAllConditionalStyle().find((conditionalStyle) => (conditionalStyle === null || conditionalStyle === void 0 ? void 0 : conditionalStyle.Uuid) === id);
     }
     getAllSuspendedConditionalStyle() {
         return this.getAllConditionalStyle().filter((style) => style.IsSuspended);

package/src/Api/Implementation/ConfigApiImpl.js

@@ -79,7 +79,11 @@ class ConfigApiImpl extends ApiBase_1.ApiBase {
         return Object.values(this.getPersistedState());
     }
     loadUserState(state) {
-        this.reloadPredefinedConfig(state);
+        const adaptableOptions = this.adaptable.adaptableOptions;
+        this.setAdaptableStateKey(adaptableOptions.adaptableStateKey, {
+            predefinedConfig: state || adaptableOptions.predefinedConfig,
+            flushCurrentState: false,
+        });
     }
     getAdaptableSearchState() {
         const currentQuery = this.adaptable.api.queryApi.getCurrentQuery();

package/src/Api/Implementation/CustomSortApiImpl.js

@@ -10,11 +10,11 @@ class CustomSortApiImpl extends ApiBase_1.ApiBase {
         return this.getAdaptableState().CustomSort;
     }
     getAllCustomSort() {
-        return this.getAdaptableState().CustomSort.CustomSorts;
+        var _a, _b;
+        return ((_b = (_a = this.getCustomSortState().CustomSorts) === null || _a === void 0 ? void 0 : _a.filter((customSort) => this.adaptable.api.internalApi.isObjectAvailableInLayout(customSort, 'CustomSort'))) !== null && _b !== void 0 ? _b : []);
     }
     getCustomSortById(id) {
-        var _a;
-        return (_a = this.getAllCustomSort()) === null || _a === void 0 ? void 0 : _a.find((customSort) => customSort.Uuid === id);
+        return this.getAllCustomSort().find((customSort) => customSort.Uuid === id);
     }
     getAllActiveCustomSort() {
         return this.getAllCustomSort().filter((customSort) => !customSort.IsSuspended);
@@ -23,7 +23,7 @@ class CustomSortApiImpl extends ApiBase_1.ApiBase {
         return this.getAllCustomSort().filter((customSort) => customSort.IsSuspended);
     }
     getCustomSortByColumn(column) {
-        return this.getAdaptableState().CustomSort.CustomSorts.find((cs) => cs.ColumnId == column);
+        return this.getAllCustomSort().find((cs) => cs.ColumnId == column);
     }
     addCustomSort(customSort) {
         this.addUidToAdaptableObject(customSort);

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

@@ -5,6 +5,7 @@ import { EmitterCallback } from '../../Utilities/Emitter';
 export declare class EventApiImpl extends ApiBase implements EventApi {
     private emitter;
     constructor(adaptable: IAdaptable);
+    destroy(): void;
     on: (eventName: string, callback: EmitterCallback) => (() => void);
     off: (eventName: string, callback: EmitterCallback) => void;
     emit: (eventName: string, data?: any) => Promise<any>;

package/src/Api/Implementation/EventApiImpl.js

@@ -23,5 +23,8 @@ class EventApiImpl extends ApiBase_1.ApiBase {
         this.emitSync = (eventName, data) => this.emitter.emitSync(eventName, data);
         this.emitter = new Emitter_1.default();
     }
+    destroy() {
+        this.emitter.destroy();
+    }
 }
 exports.EventApiImpl = EventApiImpl;

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

@@ -12,11 +12,14 @@ export declare class ExportApiImpl extends ApiBase implements ExportApi {
     getReportByName(reportName: string): Report | undefined;
     getReportById(id: Report['Uuid']): Report;
     getDestinationByName(destinationName: ExportDestination | string): ExportDestination | CustomDestination | undefined;
+    getCurrentDestination(): ExportDestination | CustomDestination;
     getAvailableSystemReports(): SystemReportNames;
     getAvailableExportDestinations(): ExportDestination[];
     getAllReports(): Report[];
     getReportSchedules(): ReportSchedule[];
     sendReport(reportName: string, destination: 'Excel' | 'CSV' | 'Clipboard' | 'JSON' | string): void;
+    selectReport(reportName: string): void;
+    selectDestination(destinationName: string): void;
     getAllCustomDestination(): CustomDestination[];
     isExportDestinationCustom(destinationName: string): boolean;
     getExportDestinationForm(destinationName: string): AdaptableForm<ExportButtonContext> | undefined;

package/src/Api/Implementation/ExportApiImpl.js

@@ -37,6 +37,10 @@ class ExportApiImpl extends ApiBase_1.ApiBase {
         }
         return this.getAllCustomDestination().find((destination) => destination.name === destinationName);
     }
+    getCurrentDestination() {
+        const currentDestination = this.getExportState().CurrentDestination;
+        return currentDestination && this.getDestinationByName(currentDestination);
+    }
     getAvailableSystemReports() {
         return this.getExportOptions().systemReportNames.filter((s) => this.adaptable.api.internalApi.getReportService().IsSystemReportActive(s));
     }
@@ -65,6 +69,12 @@ class ExportApiImpl extends ApiBase_1.ApiBase {
             this.dispatchAction(ExportRedux.ExportApply(report, destination));
         }
     }
+    selectReport(reportName) {
+        this.dispatchAction(ExportRedux.ReportSelect(reportName));
+    }
+    selectDestination(destinationName) {
+        this.dispatchAction(ExportRedux.DestinationSelect(destinationName));
+    }
     getAllCustomDestination() {
         var _a;
         return (_a = this.getExportOptions().customDestinations) !== null && _a !== void 0 ? _a : [];

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

@@ -6,8 +6,8 @@ import { AdaptablePredicateDef } from '../../PredefinedConfig/Common/AdaptablePr
 import { AdaptableScope } from '../../PredefinedConfig/Common/AdaptableScope';
 export declare class FlashingCellApiImpl extends ApiBase implements FlashingCellApi {
     getFlashingCellState(): FlashingCellState;
-    mergeFlashingCellDefinitionWithDefaults(flashingCellDefinition: FlashingCellDefinition): FlashingCellDefinition;
     getFlashingCellDefinitions(): FlashingCellDefinition[];
+    mergeFlashingCellDefinitionWithDefaults(flashingCellDefinition: FlashingCellDefinition): FlashingCellDefinition;
     getFlashingCellDefinitionById(id: FlashingCellDefinition['Uuid']): FlashingCellDefinition;
     getActiveFlashingCellDefinitions(): FlashingCellDefinition[];
     getFlashingCellFlashTarget(flashingCellDefinition: FlashingCellDefinition): FlashingCellDefinition['FlashTarget'];

package/src/Api/Implementation/FlashingCellApiImpl.js

@@ -9,6 +9,13 @@ class FlashingCellApiImpl extends ApiBase_1.ApiBase {
     getFlashingCellState() {
         return this.getAdaptableState().FlashingCell;
     }
+    getFlashingCellDefinitions() {
+        var _a, _b;
+        const flashingCellDefinitions = (_b = (_a = this.getFlashingCellState().FlashingCellDefinitions) === null || _a === void 0 ? void 0 : _a.filter((flashingCellDefinition) => this.adaptable.api.internalApi.isObjectAvailableInLayout(flashingCellDefinition, 'FlashingCell'))) !== null && _b !== void 0 ? _b : [];
+        return flashingCellDefinitions.map((flashingCellDefinition) => {
+            return this.mergeFlashingCellDefinitionWithDefaults(flashingCellDefinition);
+        });
+    }
     mergeFlashingCellDefinitionWithDefaults(flashingCellDefinition) {
         const flashingDefaults = this.adaptable.adaptableOptions.flashingCellOptions;
         if (!flashingDefaults) {
@@ -31,12 +38,6 @@ class FlashingCellApiImpl extends ApiBase_1.ApiBase {
         }
         return flashingCellDefinition;
     }
-    getFlashingCellDefinitions() {
-        const flashingCellDefinitions = this.getFlashingCellState().FlashingCellDefinitions;
-        return flashingCellDefinitions.map((flashingCellDefinition) => {
-            return this.mergeFlashingCellDefinitionWithDefaults(flashingCellDefinition);
-        });
-    }
     getFlashingCellDefinitionById(id) {
         var _a;
         return (_a = this.getFlashingCellDefinitions()) === null || _a === void 0 ? void 0 : _a.find((fc) => (fc === null || fc === void 0 ? void 0 : fc.Uuid) === id);

package/src/Api/Implementation/FormatColumnApiImpl.js

@@ -13,11 +13,11 @@ class FormatColumnApiImpl extends ApiBase_1.ApiBase {
         return this.getAdaptableState().FormatColumn;
     }
     getAllFormatColumn() {
-        return this.getAdaptableState().FormatColumn.FormatColumns;
+        var _a, _b;
+        return ((_b = (_a = this.getFormatColumnState().FormatColumns) === null || _a === void 0 ? void 0 : _a.filter((formatColumn) => this.adaptable.api.internalApi.isObjectAvailableInLayout(formatColumn, 'FormatColumn'))) !== null && _b !== void 0 ? _b : []);
     }
     getFormatColumnById(id) {
-        var _a;
-        return (_a = this.getAllFormatColumn()) === null || _a === void 0 ? void 0 : _a.find((formatColumn) => formatColumn.Uuid === id);
+        return this.getAllFormatColumn().find((formatColumn) => formatColumn.Uuid === id);
     }
     getAllActiveFormatColumn() {
         return this.getAllFormatColumn().filter((formatColumn) => !formatColumn.IsSuspended);
@@ -57,10 +57,10 @@ class FormatColumnApiImpl extends ApiBase_1.ApiBase {
         return returnValues;
     }
     getAllFormatColumnWithDisplayFormat() {
-        return this.getAdaptableState().FormatColumn.FormatColumns.filter((fc) => fc.DisplayFormat != null);
+        return this.getAllFormatColumn().filter((fc) => fc.DisplayFormat != null);
     }
     getAllFormatColumnWithCellAlignment() {
-        return this.getAdaptableState().FormatColumn.FormatColumns.filter((fc) => fc.CellAlignment != null);
+        return this.getAllFormatColumn().filter((fc) => fc.CellAlignment != null);
     }
     addFormatColumn(formatColumn) {
         this.addUidToAdaptableObject(formatColumn);

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

@@ -11,7 +11,7 @@ import { SelectedRowInfo } from '../../PredefinedConfig/Selection/SelectedRowInf
 import { AdaptableModule, AdaptableQLModule } from '../../PredefinedConfig/Common/Types';
 import { GridCell } from '../../PredefinedConfig/Selection/GridCell';
 import { CellDataChangedInfo } from '../../PredefinedConfig/Common/CellDataChangedInfo';
-import { AdaptableCellChangedAlert, AdaptableOptions, AdaptableRowChangedAlert, AdaptableState, AlertButtonContext, Layout, SystemStatusMessageInfo } from '../../types';
+import { AdaptableCellChangedAlert, AdaptableOptions, AdaptableRowChangedAlert, AdaptableState, AlertButtonContext, BaseContext, Layout, LayoutAssociatedObject, SystemStatusMessageInfo } from '../../types';
 import { IValidationService } from '../../Utilities/Services/Interface/IValidationService';
 import { IModuleService } from '../../Utilities/Services/Interface/IModuleService';
 import { IReportService } from '../../Utilities/Services/Interface/IReportService';
@@ -27,13 +27,14 @@ import { RowNode } from '@ag-grid-community/all-modules';
 import { ITeamSharingService } from '../../Utilities/Services/Interface/ITeamSharingService';
 import { ColumnValuesComparer } from '../../AdaptableOptions/GeneralOptions';
 import { ButtonStyle } from '../../PredefinedConfig/Common/ButtonStyle';
-import { AdaptableButton, ButtonContext } from '../../PredefinedConfig/Common/AdaptableButton';
+import { AdaptableButton } from '../../PredefinedConfig/Common/AdaptableButton';
 import { AdaptableForm } from '../../PredefinedConfig/Common/AdaptableForm';
 import { AlertButtonForm, AlertDefinition } from '../../PredefinedConfig/AlertState';
 import { AdaptableMessageType } from '../../PredefinedConfig/Common/AdaptableMessageType';
 import { AdaptableFrameworkComponent } from '../../AdaptableOptions/AdaptableFrameworkComponent';
 import { IMetamodelService } from '../../Utilities/Services/Interface/IMetamodelService';
 import { IModuleCollection } from '../../Strategy/Interface/IModule';
+import { AdaptableObjectTag } from '../../PredefinedConfig/Common/AdaptableObject';
 export declare class InternalApiImpl extends ApiBase implements InternalApi {
     getSystemState(): SystemState;
     getAdaptableFormFromAlertForm(alertForm: string | AlertButtonForm, context: any, defaultMessageType?: AdaptableMessageType): (Omit<AdaptableForm<AlertButtonContext>, 'buttons'> & {
@@ -107,9 +108,9 @@ export declare class InternalApiImpl extends ApiBase implements InternalApi {
     clearGradientColumnState(): void;
     clearPercentBarState(): void;
     getCustomSortComparer(column: AdaptableColumn): ColumnValuesComparer | undefined;
-    getLabelForButton(button: AdaptableButton<ButtonContext>, context: ButtonContext): string | undefined;
-    getTooltipForButton(button: AdaptableButton<ButtonContext>, context: ButtonContext): string | undefined;
-    getStyleForButton(button: AdaptableButton<ButtonContext>, context: ButtonContext): ButtonStyle | undefined;
+    getLabelForButton(button: AdaptableButton<BaseContext>, context: BaseContext): string | undefined;
+    getTooltipForButton(button: AdaptableButton<BaseContext>, context: BaseContext): string | undefined;
+    getStyleForButton(button: AdaptableButton<BaseContext>, context: BaseContext): ButtonStyle | undefined;
     isDocumentationLinksDisplayed(): boolean;
     getQueryPreviewData(): any;
     waitForTeamSharingImportEnd(): Promise<boolean>;
@@ -121,5 +122,10 @@ export declare class InternalApiImpl extends ApiBase implements InternalApi {
     executeWithProgressIndicator(label: string, executeFn: () => void): void;
     hideProgressIndicator(): void;
     getCorrectEnglishVariant(wordToSpell: string): string;
+    isObjectAvailableInLayout(object: LayoutAssociatedObject, module: AdaptableModule): boolean;
+    shouldDisplayTagSections(): boolean;
+    getAvailableTags(): AdaptableObjectTag[] | undefined;
+    private getObjectTags;
+    private getLayoutTags;
     dispatchReduxAction(action: Action): void;
 }

package/src/Api/Implementation/InternalApiImpl.js

@@ -117,10 +117,14 @@ class InternalApiImpl extends ApiBase_1.ApiBase {
         const { AdaptableFlashingCells: AdaptableFlashingAlerts, AdaptableFlashingCellsMap: AdaptableFlashingAlertsMap, } = this.getSystemState();
         const forPrimaryKey = (_a = AdaptableFlashingAlerts[primaryKey]) !== null && _a !== void 0 ? _a : {};
         const toFlashingAlert = (uuid) => { var _a; return uuid ? (_a = AdaptableFlashingAlertsMap[uuid]) !== null && _a !== void 0 ? _a : null : null; };
-        if (!columnId) {
-            return toFlashingAlert(forPrimaryKey[SystemRedux_1.FLASHING_CELL_ROW_KEY]);
+        const adaptableFlashingCell = columnId
+            ? toFlashingAlert(forPrimaryKey[columnId])
+            : toFlashingAlert(forPrimaryKey[SystemRedux_1.FLASHING_CELL_ROW_KEY]);
+        if ((adaptableFlashingCell === null || adaptableFlashingCell === void 0 ? void 0 : adaptableFlashingCell.flashingCellDefinition) &&
+            !this.isObjectAvailableInLayout(adaptableFlashingCell.flashingCellDefinition, 'FlashingCell')) {
+            return;
         }
-        return toFlashingAlert(forPrimaryKey[columnId]);
+        return adaptableFlashingCell;
     }
     addSystemStatusMessageInfo(systemStatusMessageInfo) {
         const maxMessagesInStore = this.getNotificationsOptions().maxSystemMessagesInStore;
@@ -465,6 +469,64 @@ class InternalApiImpl extends ApiBase_1.ApiBase {
         }
         return wordToSpell;
     }
+    isObjectAvailableInLayout(object, module) {
+        if (!this.adaptable.adaptableOptions.layoutOptions.isObjectAvailableInLayout) {
+            return true;
+        }
+        const context = {
+            object,
+            module,
+            layout: this.adaptable.api.layoutApi.getCurrentLayout(),
+            adaptableApi: this.adaptable.api,
+        };
+        return this.adaptable.adaptableOptions.layoutOptions.isObjectAvailableInLayout(context);
+    }
+    shouldDisplayTagSections() {
+        return this.getAvailableTags() != undefined;
+    }
+    getAvailableTags() {
+        const layoutTags = this.getLayoutTags();
+        const objectTags = this.getObjectTags();
+        if (!layoutTags && !objectTags) {
+            return;
+        }
+        return [...(layoutTags || []), ...(objectTags || [])];
+    }
+    getObjectTags() {
+        if (!this.adaptable.adaptableOptions.userInterfaceOptions.objectTags) {
+            return;
+        }
+        if (Array.isArray(this.adaptable.adaptableOptions.userInterfaceOptions.objectTags)) {
+            return this.adaptable.adaptableOptions.userInterfaceOptions.objectTags;
+        }
+        if (typeof this.adaptable.adaptableOptions.userInterfaceOptions.objectTags === 'function') {
+            // sanitize the provided tags, just to be sure that the user does NOT break the UI
+            return this.adaptable.adaptableOptions.userInterfaceOptions
+                .objectTags(this.adaptable.api)
+                .filter((tag) => (tag === null || tag === void 0 ? void 0 : tag.value) != undefined && (tag === null || tag === void 0 ? void 0 : tag.label) != undefined);
+        }
+    }
+    getLayoutTags() {
+        if (!this.adaptable.adaptableOptions.layoutOptions.autoGenerateTagsForLayouts) {
+            return;
+        }
+        if (this.adaptable.adaptableOptions.layoutOptions.autoGenerateTagsForLayouts === true) {
+            return this.adaptable.api.layoutApi.getAllLayout().map((layout) => {
+                return {
+                    label: layout.Name,
+                    value: layout.Name,
+                };
+            });
+        }
+        if (typeof this.adaptable.adaptableOptions.layoutOptions.autoGenerateTagsForLayouts === 'function') {
+            const customGeneratedTags = this.adaptable.adaptableOptions.layoutOptions.autoGenerateTagsForLayouts({
+                layouts: this.adaptable.api.layoutApi.getAllLayout(),
+                adaptableApi: this.adaptable.api,
+            });
+            // sanitize the provided tags, just to be sure that the user does NOT break the UI
+            return customGeneratedTags.filter((tag) => (tag === null || tag === void 0 ? void 0 : tag.value) != undefined && (tag === null || tag === void 0 ? void 0 : tag.label) != undefined);
+        }
+    }
     // General way to get to store from inside Adaptable...
     dispatchReduxAction(action) {
         this.dispatchAction(action);

package/src/Api/Implementation/PlusMinusApiImpl.js

@@ -10,15 +10,12 @@ class PlusMinusApiImpl extends ApiBase_1.ApiBase {
         return this.getAdaptableState().PlusMinus;
     }
     getAllPlusMinus() {
-        let returnvalue = [];
-        // get with expressions
-        returnvalue.push(...this.getPlusMinusState().PlusMinusNudges.filter((p) => { var _a; return ((_a = p.Rule) === null || _a === void 0 ? void 0 : _a.BooleanExpression) != undefined; }));
-        returnvalue.push(...this.getPlusMinusState().PlusMinusNudges.filter((p) => p.Rule == undefined));
-        return returnvalue;
+        var _a, _b;
+        const layoutSpecificPlusMinusNudges = (_b = (_a = this.getPlusMinusState().PlusMinusNudges) === null || _a === void 0 ? void 0 : _a.filter((plusMinusNudge) => this.adaptable.api.internalApi.isObjectAvailableInLayout(plusMinusNudge, 'PlusMinus'))) !== null && _b !== void 0 ? _b : [];
+        return layoutSpecificPlusMinusNudges.filter((plusMinusNudge) => plusMinusNudge.Rule == undefined || plusMinusNudge.Rule.BooleanExpression != undefined);
     }
     getPlusMinusById(id) {
-        var _a;
-        return (_a = this.getAllPlusMinus()) === null || _a === void 0 ? void 0 : _a.find((plusMinus) => (plusMinus === null || plusMinus === void 0 ? void 0 : plusMinus.Uuid) === id);
+        return this.getAllPlusMinus().find((plusMinus) => (plusMinus === null || plusMinus === void 0 ? void 0 : plusMinus.Uuid) === id);
     }
     getAllActivePlusMinus() {
         return this.getAllPlusMinus().filter((plusMinusNudge) => !plusMinusNudge.IsSuspended);

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

@@ -5,8 +5,9 @@ import { ReportSchedule } from '../../PredefinedConfig/ExportState';
 import { Glue42Schedule } from '../../PredefinedConfig/Glue42State';
 import { IPushPullSchedule } from '../../PredefinedConfig/IPushPullState';
 import { OpenFinSchedule } from '../../PredefinedConfig/OpenFinState';
-import { ReminderSchedule } from '../../PredefinedConfig/ScheduleState';
+import { ReminderSchedule, ScheduleState } from '../../PredefinedConfig/ScheduleState';
 export declare class ScheduleApiImpl extends ApiBase implements ScheduleApi {
+    getScheduleState(): ScheduleState;
     getAllSchedule(): BaseSchedule[];
     getAllReminderSchedule(): ReminderSchedule[];
     getScheduleById(id: BaseSchedule['Uuid']): BaseSchedule;

package/src/Api/Implementation/ScheduleApiImpl.js

@@ -6,6 +6,9 @@ const ApiBase_1 = require("./ApiBase");
 const ModuleConstants = tslib_1.__importStar(require("../../Utilities/Constants/ModuleConstants"));
 const ScheduleRedux = tslib_1.__importStar(require("../../Redux/ActionsReducers/ScheduleRedux"));
 class ScheduleApiImpl extends ApiBase_1.ApiBase {
+    getScheduleState() {
+        return this.getAdaptableState().Schedule;
+    }
     getAllSchedule() {
         let allSchedules = [];
         allSchedules.push(...this.getAllReminderSchedule());
@@ -16,11 +19,11 @@ class ScheduleApiImpl extends ApiBase_1.ApiBase {
         return allSchedules;
     }
     getAllReminderSchedule() {
-        return this.getAdaptableState().Schedule.Reminders;
+        var _a, _b;
+        return ((_b = (_a = this.getScheduleState().Reminders) === null || _a === void 0 ? void 0 : _a.filter((schedule) => this.adaptable.api.internalApi.isObjectAvailableInLayout(schedule, 'Schedule'))) !== null && _b !== void 0 ? _b : []);
     }
     getScheduleById(id) {
-        var _a;
-        return (_a = this.getAllSchedule()) === null || _a === void 0 ? void 0 : _a.find((schedule) => (schedule === null || schedule === void 0 ? void 0 : schedule.Uuid) === id);
+        return this.getAllSchedule().find((schedule) => (schedule === null || schedule === void 0 ? void 0 : schedule.Uuid) === id);
     }
     getAllActiveReminderSchedule() {
         return this.getAllReminderSchedule().filter((schedule) => !schedule.IsSuspended);
@@ -48,7 +51,9 @@ class ScheduleApiImpl extends ApiBase_1.ApiBase {
         return this.getScheduleById(schedule.Uuid);
     }
     getAllReportSchedule() {
-        return this.adaptable.api.exportApi.getReportSchedules();
+        var _a, _b;
+        return ((_b = (_a = this.adaptable.api.exportApi
+            .getReportSchedules()) === null || _a === void 0 ? void 0 : _a.filter((schedule) => this.adaptable.api.internalApi.isObjectAvailableInLayout(schedule, 'Schedule'))) !== null && _b !== void 0 ? _b : []);
     }
     getAllActiveReportSchedule() {
         return this.getAllReportSchedule().filter((schedule) => !schedule.IsSuspended);
@@ -76,8 +81,9 @@ class ScheduleApiImpl extends ApiBase_1.ApiBase {
         return this.getScheduleById(schedule.Uuid);
     }
     getAllIPushPullSchedule() {
+        var _a, _b;
         const ippApi = this.adaptable.api.pluginsApi.getipushpullPluginApi();
-        return ippApi ? ippApi.getIPushPullSchedules() : [];
+        return ((_b = (_a = ippApi === null || ippApi === void 0 ? void 0 : ippApi.getIPushPullSchedules()) === null || _a === void 0 ? void 0 : _a.filter((schedule) => this.adaptable.api.internalApi.isObjectAvailableInLayout(schedule, 'Schedule'))) !== null && _b !== void 0 ? _b : []);
     }
     getAllActiveIPushPullSchedule() {
         return this.getAllIPushPullSchedule().filter((schedule) => !schedule.IsSuspended);
@@ -105,8 +111,9 @@ class ScheduleApiImpl extends ApiBase_1.ApiBase {
         return this.getScheduleById(schedule.Uuid);
     }
     getAllGlue42Schedule() {
+        var _a, _b;
         const glue42Api = this.adaptable.api.pluginsApi.getGlue42PluginApi();
-        return glue42Api ? glue42Api.getGlue42Schedules() : [];
+        return ((_b = (_a = glue42Api === null || glue42Api === void 0 ? void 0 : glue42Api.getGlue42Schedules()) === null || _a === void 0 ? void 0 : _a.filter((schedule) => this.adaptable.api.internalApi.isObjectAvailableInLayout(schedule, 'Schedule'))) !== null && _b !== void 0 ? _b : []);
     }
     getAllActiveGlue42Schedule() {
         return this.getAllGlue42Schedule().filter((schedule) => !schedule.IsSuspended);
@@ -134,8 +141,9 @@ class ScheduleApiImpl extends ApiBase_1.ApiBase {
         return this.getScheduleById(schedule.Uuid);
     }
     getAllOpenFinSchedule() {
+        var _a, _b;
         const openFinApi = this.adaptable.api.pluginsApi.getOpenFinPluginApi();
-        return openFinApi ? openFinApi.getOpenFinSchedules() : [];
+        return ((_b = (_a = openFinApi === null || openFinApi === void 0 ? void 0 : openFinApi.getOpenFinSchedules()) === null || _a === void 0 ? void 0 : _a.filter((schedule) => this.adaptable.api.internalApi.isObjectAvailableInLayout(schedule, 'Schedule'))) !== null && _b !== void 0 ? _b : []);
     }
     getAllActiveOpenFinSchedule() {
         return this.getAllOpenFinSchedule().filter((schedule) => !schedule.IsSuspended);

package/src/Api/Implementation/ShortcutApiImpl.js

@@ -10,11 +10,11 @@ class ShortcutApiImpl extends ApiBase_1.ApiBase {
         return this.getAdaptableState().Shortcut;
     }
     getAllShortcut() {
-        return this.getAdaptableState().Shortcut.Shortcuts;
+        var _a, _b;
+        return ((_b = (_a = this.getShortcutState().Shortcuts) === null || _a === void 0 ? void 0 : _a.filter((shortcut) => this.adaptable.api.internalApi.isObjectAvailableInLayout(shortcut, 'Shortcut'))) !== null && _b !== void 0 ? _b : []);
     }
     getShortcutById(id) {
-        var _a;
-        return (_a = this.getAllShortcut()) === null || _a === void 0 ? void 0 : _a.find((shortcut) => (shortcut === null || shortcut === void 0 ? void 0 : shortcut.Uuid) === id);
+        return this.getAllShortcut().find((shortcut) => (shortcut === null || shortcut === void 0 ? void 0 : shortcut.Uuid) === id);
     }
     getAllActiveShortcut() {
         return this.getAllShortcut().filter((shortcut) => !shortcut.IsSuspended);

package/src/Api/InternalApi.d.ts

@@ -17,14 +17,14 @@ import { AdaptableOptions } from '../AdaptableOptions/AdaptableOptions';
 import { Layout } from '../PredefinedConfig/LayoutState';
 import { AdaptableAlert, AdaptableCellChangedAlert, AdaptableRowChangedAlert } from '../PredefinedConfig/Common/AdaptableAlert';
 import { IDataService } from '../Utilities/Services/Interface/IDataService';
-import { AdaptableMessageType, AlertDefinition, CellDataChangedInfo, SystemStatusMessageInfo } from '../types';
+import { AdaptableMessageType, AlertDefinition, BaseContext, CellDataChangedInfo, LayoutAssociatedObject, SystemStatusMessageInfo } from '../types';
 import { IEntitlementService } from '../Utilities/Services/Interface/IEntitlementService';
 import { AdaptableFlashingCell } from '../PredefinedConfig/Common/AdaptableFlashingCell';
 import { IQueryLanguageService } from '../Utilities/Services/Interface/IQueryLanguageService';
 import { IAlertService } from '../Utilities/Services/Interface/IAlertService';
 import { AdaptableState } from '../PredefinedConfig/AdaptableState';
 import { ITeamSharingService } from '../Utilities/Services/Interface/ITeamSharingService';
-import { AdaptableButton, ButtonContext } from '../PredefinedConfig/Common/AdaptableButton';
+import { AdaptableButton } from '../PredefinedConfig/Common/AdaptableButton';
 import { ColumnValuesComparer } from '../AdaptableOptions/GeneralOptions';
 import { ButtonStyle } from '../PredefinedConfig/Common/ButtonStyle';
 import { AdaptableForm } from '../PredefinedConfig/Common/AdaptableForm';
@@ -33,6 +33,7 @@ import { AdaptableFrameworkComponent } from '../AdaptableOptions/AdaptableFramew
 import { IMetamodelService } from '../Utilities/Services/Interface/IMetamodelService';
 import { RowNode } from '@ag-grid-community/all-modules';
 import { IModuleCollection } from '../Strategy/Interface/IModule';
+import { AdaptableObjectTag } from '../PredefinedConfig/Common/AdaptableObject';
 /**
  * This set of api methods is designed for **internal use of Adaptable** only.
  *
@@ -40,8 +41,8 @@ import { IModuleCollection } from '../Strategy/Interface/IModule';
  */
 export interface InternalApi {
     getSystemState(): SystemState;
-    getAdaptableFormFromAlertForm(alertForm: string | AlertButtonForm, context: any, defaultMessageType?: AdaptableMessageType): Omit<AdaptableForm<ButtonContext>, 'buttons'> & {
-        buttons?: (Omit<AdaptableButton<ButtonContext>, 'buttonStyle'> & {
+    getAdaptableFormFromAlertForm(alertForm: string | AlertButtonForm, context: any, defaultMessageType?: AdaptableMessageType): Omit<AdaptableForm<BaseContext>, 'buttons'> & {
+        buttons?: (Omit<AdaptableButton<BaseContext>, 'buttonStyle'> & {
             buttonStyle?: ButtonStyle;
         })[];
     };
@@ -111,9 +112,9 @@ export interface InternalApi {
     clearUpdatedRowState(): void;
     clearGradientColumnState(): void;
     clearPercentBarState(): void;
-    getLabelForButton(button: AdaptableButton<ButtonContext>, context: ButtonContext): string | undefined;
-    getTooltipForButton(button: AdaptableButton<ButtonContext>, context: ButtonContext): string | undefined;
-    getStyleForButton(button: AdaptableButton<ButtonContext>, context: ButtonContext): ButtonStyle | undefined;
+    getLabelForButton(button: AdaptableButton<BaseContext>, context: BaseContext): string | undefined;
+    getTooltipForButton(button: AdaptableButton<BaseContext>, context: BaseContext): string | undefined;
+    getStyleForButton(button: AdaptableButton<BaseContext>, context: BaseContext): ButtonStyle | undefined;
     dispatchReduxAction(action: Action): void;
     waitForTeamSharingImportEnd(): Promise<boolean>;
     getUserDefinedHeaderName(columnId: string): string;
@@ -121,7 +122,10 @@ export interface InternalApi {
     destroyFrameworkComponent(containerDomNode: HTMLElement, frameworkComponent: AdaptableFrameworkComponent, componentType: 'toolPanel' | 'toolbar' | string): void;
     initializeDataChangeHistory(): void;
     isTextComparisonCaseSensitive(): boolean;
+    isObjectAvailableInLayout(object: LayoutAssociatedObject, module: AdaptableModule): boolean;
     executeWithProgressIndicator(label: string, executeFn: () => unknown): void;
     hideProgressIndicator(): void;
     getCorrectEnglishVariant(wordToSpell: string): string;
+    shouldDisplayTagSections(): boolean;
+    getAvailableTags(): AdaptableObjectTag[] | undefined;
 }

package/src/Api/LayoutApi.d.ts

@@ -68,7 +68,7 @@ export interface LayoutApi {
      * Saves given Layout into Adaptable State (creates new Layout if it doesn't exist)
      * @param layoutToSave the Layout to save
      *
-     * @deprecated use {@link createOrUpdateLayout} instead
+     * @deprecated use `createOrUpdateLayout()` instead
      */
     saveLayout(layoutToSave: Layout): void;
     /**
@@ -136,9 +136,8 @@ export interface LayoutApi {
     showLayoutPopup(): void;
     /**
      * Opens Layout Editor - for Current or a named Layout
-     *
      * @param layoutName Name of Layout to be edited or cloned; if not specified, uses Current Layout
-     * @param action Whether to edit/clone, or create a new, Layout
+     * @param action Whether to edit, clone, or create a new Layout
      */
     showLayoutEditor(layoutName?: string, 
     /**
@@ -166,9 +165,8 @@ export interface LayoutApi {
      */
     isCurrentLayoutReadOnly(): boolean;
     /**
-     * Opens change column caption popup
-     *
-     * @param column AdaptableColumn
+     * Opens Change Column Caption popup
+     * @param column Column to open Popup for
      */
     showChangeColumnCaption(column: AdaptableColumn): void;
     /**

package/src/Api/ScheduleApi.d.ts

@@ -3,11 +3,15 @@ import { ReportSchedule } from '../PredefinedConfig/ExportState';
 import { Glue42Schedule } from '../PredefinedConfig/Glue42State';
 import { IPushPullSchedule } from '../PredefinedConfig/IPushPullState';
 import { OpenFinSchedule } from '../PredefinedConfig/OpenFinState';
-import { ReminderSchedule } from '../PredefinedConfig/ScheduleState';
+import { ReminderSchedule, ScheduleState } from '../PredefinedConfig/ScheduleState';
 /**
  * Provides run-time access to the Schedule Module and associated state
  */
 export interface ScheduleApi {
+    /**
+     * Retrieves Schedule section from Adaptable State
+     */
+    getScheduleState(): ScheduleState;
     /**
      * Retrieves the Schedule section from Adaptable State
      * @returns schedules

package/src/PredefinedConfig/AlertState.d.ts

@@ -4,13 +4,13 @@ import { AdaptablePredicate } from './Common/AdaptablePredicate';
 import { TypeHint } from './Common/Types';
 import { AdaptableMessageType } from './Common/AdaptableMessageType';
 import { AdaptableForm } from './Common/AdaptableForm';
-import { AdaptableButton, ButtonContext } from './Common/AdaptableButton';
+import { AdaptableButton } from './Common/AdaptableButton';
 import { SuspendableObject } from './Common/SuspendableObject';
 import { AdaptableStyle } from './Common/AdaptableStyle';
 import { XOR } from '../Utilities/Extensions/TypeExtensions';
 import { AdaptableAggregatedBooleanQuery, AdaptableBooleanQuery, AdaptableObservableQuery } from './Common/AdaptableQuery';
 import { ButtonStyle } from './Common/ButtonStyle';
-import { AlertButtonContext } from '../types';
+import { AlertButtonContext, BaseContext } from '../types';
 /**
  * Predefined Configuration for Alert Module
  */
@@ -69,7 +69,7 @@ export declare type AdaptableAlertAction = 'highlight-cell' | 'highlight-row' |
 /**
  * Defines a button that appears in an Alert Form
  */
-export interface AlertButton<AlertButtonContext> extends Omit<AdaptableButton<ButtonContext>, 'onClick' | 'label' | 'buttonStyle' | 'hidden' | 'disabled' | 'tooltip'> {
+export interface AlertButton<AlertButtonContext> extends Omit<AdaptableButton<BaseContext>, 'onClick' | 'label' | 'buttonStyle' | 'hidden' | 'disabled' | 'tooltip'> {
     /**
      * Predefined Action(s) to trigger when button is clicked; but the implementation in `actionHandlers` property of Alert Options
      */