@adaptabletools/adaptable 22.0.0-canary.1 → 22.0.0-canary.11

package/src/Utilities/Services/FlashingCellService.js

@@ -3,6 +3,11 @@ export const FLASHING_CELL_ROW_KEY = '__ROW';
  * This service manages Flashing Cells
  */
 export class FlashingCellService {
+    api;
+    // map of rowPrimaryKey -> ColIdOrRowId -> FlashingCellUuid
+    gridCellsCurrentlyFlashing;
+    // map of FlashingCellUuid -> FlashingCell
+    flashingCellsMapping;
     constructor(api) {
         this.api = api;
         this.gridCellsCurrentlyFlashing = {};

package/src/Utilities/Services/LicenseService/index.js

@@ -1 +1 @@
-import{LicenseDisablePersistence as e,LicenseShowWatermark as a}from"../../../Redux/ActionsReducers/InternalRedux";import{PopupShowAlert as t}from"../../../Redux/ActionsReducers/PopupRedux";import i from"../../ObjectFactory";import s from"lodash/clamp";import{LicenseDocsLink as o}from"../../Constants/DocumentationLinkConstants";import{decode as n,GENERIC_APP_NAME as r}from"../../license/decode";import{shouldLogThankYouMessage as l}from"./shouldLogThankYouMessage";const c="sales@adaptabletools.com",p=10,d=864e5;export var LicenseValidityType;!function(e){e.INVALID_LICENSE="INVALID_LICENSE",e.NO_LICENSE="NO_LICENSE",e.NON_PRODUCTION_VALID="NON_PRODUCTION_VALID",e.NON_PRODUCTION_EXPIRED_IN_SCOPE="NON_PRODUCTION_EXPIRED_IN_SCOPE",e.NON_PRODUCTION_EXPIRED_OUT_OF_SCOPE="NON_PRODUCTION_EXPIRED_OUT_OF_SCOPE",e.COMMERCIAL_VALID="COMMERCIAL_VALID",e.COMMERCIAL_EXPIRED_IN_SCOPE="COMMERCIAL_EXPIRED_IN_SCOPE",e.COMMERCIAL_EXPIRED_OUT_OF_SCOPE="COMMERCIAL_EXPIRED_OUT_OF_SCOPE"}(LicenseValidityType||(LicenseValidityType={}));const h=()=>"undefined"!=typeof window?window.location.origin:"",E=()=>{const e=h(),[a,t,i]=Array.from(/(https):\/\/\d+\-\d+\-\d+\-(sandpack\.codesandbox\.io)/g.exec(e)||[]);return"https"===t&&"sandpack.codesandbox.io"===i},I=()=>{const e=h(),[a,t,i]=Array.from(/(https):\/\/\S+(\.csb\.app)/g.exec(e)||[]);return"https"===t&&".csb.app"===i},_=()=>{const e=h(),[a,t,i]=Array.from(/(https):\/\/\S+(\.adaptabletools\.com)/g.exec(e)||[]);return"https"===t&&".adaptabletools.com"===i};export class LicenseService{constructor(e,a,t){this.adaptable=e,this.licenseKey=a,this.packageDetails=t,this.adaptable=e,this.adaptable.api.eventApi.on("AdaptableReady",()=>{requestAnimationFrame(()=>{this.adaptable.isDestroyed||this.init()})})}init(){let e=null;if(this.licenseKey)try{e=n(this.licenseKey)}catch(a){e=a}E()||I()||_()||this.handleLicenseValidation(e,this.getValidityType(e,this.packageDetails))}getValidityType(e,a){if(!e)return LicenseValidityType.NO_LICENSE;if(e instanceof Error)return LicenseValidityType.INVALID_LICENSE;const t=new Date(a.publishedAt),i=new Date(e.end),s=i<new Date,o=e.trial;let n=null;return n=s?i>t?o?LicenseValidityType.NON_PRODUCTION_EXPIRED_IN_SCOPE:LicenseValidityType.COMMERCIAL_EXPIRED_IN_SCOPE:o?LicenseValidityType.NON_PRODUCTION_EXPIRED_OUT_OF_SCOPE:LicenseValidityType.COMMERCIAL_EXPIRED_OUT_OF_SCOPE:o?LicenseValidityType.NON_PRODUCTION_VALID:LicenseValidityType.COMMERCIAL_VALID,n}handleLicenseValidation(e,a){const t=new Date;t.setHours(0,0,0,0);let i=0;e instanceof Error||!e?.end||(i=Math.floor((e?.end?.getTime()-t.getTime())/d),i=s(i,0,1/0));let n="",h="";!e||e instanceof Error||!e.appName||e.appName==r||(n=e.appName,h=" for application [APP_NAME]");const E=(e,a=o,t=c,s=i,r=n)=>e.replace("[LINK]",a).replace("[EMAIL]",t).replace("[APP_NAME]",r).replace("[DAYS]",`${s}`);switch(a){case"NO_LICENSE":case"NON_PRODUCTION_EXPIRED_OUT_OF_SCOPE":this.adaptable.logger.consoleLogByMessageType(E("This instance of AdapTable does not have a license, and some functionality has therefore been removed. In order to use a fully-featured version of AdapTable, please contact [EMAIL]. You can learn more about the different AdapTable license options at [LINK]."),"Error"),this.showNotification("No AdapTable License found."),this.showWatermark("This instance of AdapTable does not have a license, and some functionality has therefore been removed."),this.disableStatePersistence();break;case"INVALID_LICENSE":this.adaptable.logger.consoleLogByMessageType(E("This instance of AdapTable seems to use a corrupted License, and some functionality has therefore been removed. In order to use a fully-featured version of AdapTable, please contact [EMAIL]. You can learn more about the different AdapTable license options at [LINK]."),"Error"),this.showNotification("Corrupted AdapTable License found."),this.showWatermark("This instance of AdapTable has a corrupted License, and some functionality has therefore been removed."),this.disableStatePersistence();break;case"NON_PRODUCTION_VALID":this.adaptable.logger.consoleLogByMessageType(E("This AdapTable trial license expires in [DAYS] days. Please contact [EMAIL] to upgrade to a commercial version of AdapTable. You can learn more about the different AdapTable license options at [LINK]."),"Info");break;case"NON_PRODUCTION_EXPIRED_IN_SCOPE":this.adaptable.logger.consoleLogByMessageType(E("This AdapTable trial license has now expired. Please contact [EMAIL] to upgrade to a commercial version of AdapTable. You can learn more about the different AdapTable license options at [LINK]."),"Warning"),this.showWatermark("AdapTable License has expired");break;case"COMMERCIAL_VALID":if(i<=p)this.adaptable.logger.consoleLogByMessageType(E(`This AdapTable license${h} expires in [DAYS] days.  Please contact [EMAIL] to renew (giving you access to Support and Updates)`),"Info");else try{l()&&this.adaptable.logger.consoleLogByMessageType(E(`Thank you for using a valid AdapTable license${h}. Your license will expire in [DAYS] days.`),"Info")}catch(e){}break;case"COMMERCIAL_EXPIRED_IN_SCOPE":this.adaptable.logger.consoleLogByMessageType(E(`This AdapTable license${h} has expired.  Please contact [EMAIL] if you wish to renew (giving you access to Support and Updates)`),"Warning");break;case"COMMERCIAL_EXPIRED_OUT_OF_SCOPE":this.adaptable.logger.consoleLogByMessageType(E(`This AdapTable license${h} has expired. Adaptable version was published after the license expired. Please contact [EMAIL] if you wish to renew your license.`),"Error"),this.showNotification("Adaptable License has expired"),this.showWatermark("Adaptable License has expired")}}showNotification(e){this.adaptable.api.internalApi.dispatchReduxAction(t({alertType:"generic",header:"License Error",message:e,alertDefinition:i.CreateInternalAlertDefinitionForMessages("Error")}))}showWatermark(e){this.adaptable.api.internalApi.dispatchReduxAction(a(e))}disableStatePersistence(){this.adaptable.api.internalApi.dispatchReduxAction(e())}destroy(){}}
+import{LicenseDisablePersistence as e,LicenseShowWatermark as a}from"../../../Redux/ActionsReducers/InternalRedux";import{PopupShowAlert as t}from"../../../Redux/ActionsReducers/PopupRedux";import i from"../../ObjectFactory";import s from"lodash/clamp";import{LicenseDocsLink as o}from"../../Constants/DocumentationLinkConstants";import{decode as n,GENERIC_APP_NAME as r}from"../../license/decode";import{shouldLogThankYouMessage as l}from"./shouldLogThankYouMessage";const c="sales@adaptabletools.com",p=10,d=864e5;export var LicenseValidityType;!function(e){e.INVALID_LICENSE="INVALID_LICENSE",e.NO_LICENSE="NO_LICENSE",e.NON_PRODUCTION_VALID="NON_PRODUCTION_VALID",e.NON_PRODUCTION_EXPIRED_IN_SCOPE="NON_PRODUCTION_EXPIRED_IN_SCOPE",e.NON_PRODUCTION_EXPIRED_OUT_OF_SCOPE="NON_PRODUCTION_EXPIRED_OUT_OF_SCOPE",e.COMMERCIAL_VALID="COMMERCIAL_VALID",e.COMMERCIAL_EXPIRED_IN_SCOPE="COMMERCIAL_EXPIRED_IN_SCOPE",e.COMMERCIAL_EXPIRED_OUT_OF_SCOPE="COMMERCIAL_EXPIRED_OUT_OF_SCOPE"}(LicenseValidityType||(LicenseValidityType={}));const h=()=>"undefined"!=typeof window?window.location.origin:"",E=()=>{const e=h(),[a,t,i]=Array.from(/(https):\/\/\d+\-\d+\-\d+\-(sandpack\.codesandbox\.io)/g.exec(e)||[]);return"https"===t&&"sandpack.codesandbox.io"===i},I=()=>{const e=h(),[a,t,i]=Array.from(/(https):\/\/\S+(\.csb\.app)/g.exec(e)||[]);return"https"===t&&".csb.app"===i},_=()=>{const e=h(),[a,t,i]=Array.from(/(https):\/\/\S+(\.adaptabletools\.com)/g.exec(e)||[]);return"https"===t&&".adaptabletools.com"===i};export class LicenseService{adaptable;licenseKey;packageDetails;constructor(e,a,t){this.adaptable=e,this.licenseKey=a,this.packageDetails=t,this.adaptable=e,this.adaptable.api.eventApi.on("AdaptableReady",()=>{requestAnimationFrame(()=>{this.adaptable.isDestroyed||this.init()})})}init(){let e=null;if(this.licenseKey)try{e=n(this.licenseKey)}catch(a){e=a}E()||I()||_()||this.handleLicenseValidation(e,this.getValidityType(e,this.packageDetails))}getValidityType(e,a){if(!e)return LicenseValidityType.NO_LICENSE;if(e instanceof Error)return LicenseValidityType.INVALID_LICENSE;const t=new Date(a.publishedAt),i=new Date(e.end),s=i<new Date,o=e.trial;let n=null;return n=s?i>t?o?LicenseValidityType.NON_PRODUCTION_EXPIRED_IN_SCOPE:LicenseValidityType.COMMERCIAL_EXPIRED_IN_SCOPE:o?LicenseValidityType.NON_PRODUCTION_EXPIRED_OUT_OF_SCOPE:LicenseValidityType.COMMERCIAL_EXPIRED_OUT_OF_SCOPE:o?LicenseValidityType.NON_PRODUCTION_VALID:LicenseValidityType.COMMERCIAL_VALID,n}handleLicenseValidation(e,a){const t=new Date;t.setHours(0,0,0,0);let i=0;e instanceof Error||!e?.end||(i=Math.floor((e?.end?.getTime()-t.getTime())/d),i=s(i,0,1/0));let n="",h="";!e||e instanceof Error||!e.appName||e.appName==r||(n=e.appName,h=" for application [APP_NAME]");const E=(e,a=o,t=c,s=i,r=n)=>e.replace("[LINK]",a).replace("[EMAIL]",t).replace("[APP_NAME]",r).replace("[DAYS]",`${s}`);switch(a){case"NO_LICENSE":case"NON_PRODUCTION_EXPIRED_OUT_OF_SCOPE":this.adaptable.logger.consoleLogByMessageType(E("This instance of AdapTable does not have a license, and some functionality has therefore been removed. In order to use a fully-featured version of AdapTable, please contact [EMAIL]. You can learn more about the different AdapTable license options at [LINK]."),"Error"),this.showNotification("No AdapTable License found."),this.showWatermark("This instance of AdapTable does not have a license, and some functionality has therefore been removed."),this.disableStatePersistence();break;case"INVALID_LICENSE":this.adaptable.logger.consoleLogByMessageType(E("This instance of AdapTable seems to use a corrupted License, and some functionality has therefore been removed. In order to use a fully-featured version of AdapTable, please contact [EMAIL]. You can learn more about the different AdapTable license options at [LINK]."),"Error"),this.showNotification("Corrupted AdapTable License found."),this.showWatermark("This instance of AdapTable has a corrupted License, and some functionality has therefore been removed."),this.disableStatePersistence();break;case"NON_PRODUCTION_VALID":this.adaptable.logger.consoleLogByMessageType(E("This AdapTable trial license expires in [DAYS] days. Please contact [EMAIL] to upgrade to a commercial version of AdapTable. You can learn more about the different AdapTable license options at [LINK]."),"Info");break;case"NON_PRODUCTION_EXPIRED_IN_SCOPE":this.adaptable.logger.consoleLogByMessageType(E("This AdapTable trial license has now expired. Please contact [EMAIL] to upgrade to a commercial version of AdapTable. You can learn more about the different AdapTable license options at [LINK]."),"Warning"),this.showWatermark("AdapTable License has expired");break;case"COMMERCIAL_VALID":if(i<=p)this.adaptable.logger.consoleLogByMessageType(E(`This AdapTable license${h} expires in [DAYS] days.  Please contact [EMAIL] to renew (giving you access to Support and Updates)`),"Info");else try{l()&&this.adaptable.logger.consoleLogByMessageType(E(`Thank you for using a valid AdapTable license${h}. Your license will expire in [DAYS] days.`),"Info")}catch(e){}break;case"COMMERCIAL_EXPIRED_IN_SCOPE":this.adaptable.logger.consoleLogByMessageType(E(`This AdapTable license${h} has expired.  Please contact [EMAIL] if you wish to renew (giving you access to Support and Updates)`),"Warning");break;case"COMMERCIAL_EXPIRED_OUT_OF_SCOPE":this.adaptable.logger.consoleLogByMessageType(E(`This AdapTable license${h} has expired. Adaptable version was published after the license expired. Please contact [EMAIL] if you wish to renew your license.`),"Error"),this.showNotification("Adaptable License has expired"),this.showWatermark("Adaptable License has expired")}}showNotification(e){this.adaptable.api.internalApi.dispatchReduxAction(t({alertType:"generic",header:"License Error",message:e,alertDefinition:i.CreateInternalAlertDefinitionForMessages("Error")}))}showWatermark(e){this.adaptable.api.internalApi.dispatchReduxAction(a(e))}disableStatePersistence(){this.adaptable.api.internalApi.dispatchReduxAction(e())}destroy(){}}

package/src/Utilities/Services/MetamodelService.js

@@ -5,9 +5,9 @@ import { AdaptableLogger } from '../../agGrid/AdaptableLogger';
 import { getDefaultAdaptableOptions } from '../../AdaptableOptions/DefaultAdaptableOptions';
 const supportedMetamodelTypes = ['s', 'n', 'b', 'a', 'f', 'R'];
 export class MetamodelService {
+    gridInfoOptions = new Map();
+    getAdaptableOptions = () => null;
     constructor(getAdaptableOptions, validateOptions) {
-        this.gridInfoOptions = new Map();
-        this.getAdaptableOptions = () => null;
         this.getAdaptableOptions = getAdaptableOptions;
         this.gridInfoOptions = this.buildGridInfoOptions();
         if (validateOptions) {

package/src/Utilities/Services/ModuleService.js

@@ -1,6 +1,7 @@
 import Helper from '../Helpers/Helper';
 import { AgGridRequiredModulesDocsLink, HOST_URL_DOCS, } from '../Constants/DocumentationLinkConstants';
 export class ModuleService {
+    adaptableApi;
     constructor(adaptableApi) {
         this.adaptableApi = adaptableApi;
         this.adaptableApi = adaptableApi;
@@ -31,9 +32,7 @@ export class ModuleService {
         const registeredAgGridModuleNames = agGridModulesAdapter.getAgGridRegisteredModuleNames();
         const missingAgGridModuleNames = mandatoryAgGridModuleNames.filter((moduleName) => !registeredAgGridModuleNames.includes(moduleName));
         if (missingAgGridModuleNames.length) {
-            this.adaptableApi.consoleError(`AdapTable requires the following AG Grid modules to be registered: ${missingAgGridModuleNames.join(', ')}.
-
-        See for more information: ${AgGridRequiredModulesDocsLink}`);
+            this.adaptableApi.consoleError(`Adaptable requires these AG Grid modules: ${missingAgGridModuleNames.join(', ')}. Please register them. See: ${AgGridRequiredModulesDocsLink}`);
         }
         // log optional missing AG Grid dependencies for all modules
         this.getModuleCollection().forEach((adaptableModule) => {
@@ -113,13 +112,13 @@ export class ModuleService {
             case 'CalculatedColumn':
                 return url + 'handbook-calculated-column';
             case 'CellSummary':
-                return url + 'handbook-summarising';
+                return url + 'handbook-summarising-cells';
             case 'Charting':
                 return url + 'handbook-charts';
             case 'ColumnFilter':
                 return url + 'handbook-column-filter';
             case 'ColumnInfo':
-                return url + 'dev-guide-column-grid-column-info';
+                return url + 'dev-guide-columns-column-info';
             case 'Comment':
                 return url + 'handbook-comments';
             case 'CustomSort':
@@ -145,7 +144,7 @@ export class ModuleService {
             case 'GridFilter':
                 return url + 'handbook-grid-filter';
             case 'GridInfo':
-                return url + 'dev-guide-column-grid-column-info';
+                return url + 'dev-guide-support-monitoring';
             case 'Layout':
                 return url + 'handbook-layouts';
             case 'NamedQuery':

package/src/Utilities/Services/QueryLanguageService.js

@@ -9,13 +9,14 @@ import { scalarExpressionFunctions } from '../ExpressionFunctions/scalarExpressi
 import { getTypedKeys } from '../Extensions/TypeExtensions';
 import { AggregatedScalarLiveValue } from './AggregatedScalarLiveValue';
 export class QueryLanguageService {
+    adaptableApi;
+    cacheBooleanValidation = new Map();
+    cacheObservableValidation = new Map();
+    cacheAggregatedBooleanValidation = new Map();
+    cacheAggregatedScalarValidation = new Map();
+    cacheModuleSpecificExpressionFunctions = new Map();
     constructor(adaptableApi) {
         this.adaptableApi = adaptableApi;
-        this.cacheBooleanValidation = new Map();
-        this.cacheObservableValidation = new Map();
-        this.cacheAggregatedBooleanValidation = new Map();
-        this.cacheAggregatedScalarValidation = new Map();
-        this.cacheModuleSpecificExpressionFunctions = new Map();
     }
     evaluateBooleanExpression(expression, module, rowNode, evalContext) {
         if (expression == undefined) {

package/src/Utilities/Services/RowFormService.js

@@ -1,4 +1,5 @@
 export class RowFormService {
+    adaptableApi;
     constructor(adaptableApi) {
         this.adaptableApi = adaptableApi;
         if (adaptableApi.optionsApi.getRowFormOptions().autoHandle) {

package/src/Utilities/Services/RowSummaryService.js

@@ -10,15 +10,12 @@ import isEqual from 'lodash/isEqual';
  * The logic is extracted here to make it easier to follow
  */
 export class RowSummaryService {
+    api;
+    cachedCellSummary = new Map();
+    previousRowSummaries;
+    previousLayout;
     constructor(api) {
         this.api = api;
-        this.cachedCellSummary = new Map();
-        this._throttleAcumulatedColumnsThatChanged = new Set();
-        /**
-         *
-         * @param colId optional to evaluate only one column
-         */
-        this._throttledEvaluateRowSummary = throttle(this.evaluateRowSummary, 300);
     }
     onAdaptableReady() {
         this.rowSummariesSubscriptions();
@@ -66,12 +63,18 @@ export class RowSummaryService {
             this.throttledEvaluateRowSummary();
         });
     }
+    _throttleAcumulatedColumnsThatChanged = new Set();
     throttledEvaluateRowSummary(reason) {
         if (reason) {
             reason.columnIds.forEach((col) => this._throttleAcumulatedColumnsThatChanged.add(col));
         }
         this._throttledEvaluateRowSummary(reason);
     }
+    /**
+     *
+     * @param colId optional to evaluate only one column
+     */
+    _throttledEvaluateRowSummary = throttle(this.evaluateRowSummary, 300);
     evaluateRowSummary(reason) {
         if (this._throttleAcumulatedColumnsThatChanged.size > 0) {
             const columnIds = Array.from(this._throttleAcumulatedColumnsThatChanged.values());

package/src/Utilities/Services/TeamSharingService.js

@@ -1,9 +1,11 @@
 import { createUuid } from '../../AdaptableState/Uuid';
 import ObjectFactory from '../ObjectFactory';
 export class TeamSharingService {
+    adaptableApi;
+    dismissedNotifications = [];
+    updateCheckTimerId;
     constructor(adaptableApi) {
         this.adaptableApi = adaptableApi;
-        this.dismissedNotifications = [];
         const teamSharingOptions = adaptableApi.optionsApi.getTeamSharingOptions();
         if (teamSharingOptions.updateInterval > 0) {
             // convert minutes to millis

package/src/Utilities/Services/ThemeService.js

@@ -1,14 +1,8 @@
 export class ThemeService {
+    api;
+    unsubscribe = () => { };
+    styleSheetObject;
     constructor(api) {
-        this.unsubscribe = () => { };
-        this.onThemeChanged = () => {
-            let currentTheme = this.api.themeApi.getCurrentThemeObject();
-            currentTheme = this.mapOsTheme(currentTheme);
-            this.applyNewThemeVariables(currentTheme);
-            // this needs to be called after variables are set
-            // as it may show the warning for a custom/runtime theme
-            this.showMissingThemeFiles(currentTheme);
-        };
         this.api = api;
         this.subscribe();
         if (!this.styleSheetObject) {
@@ -33,6 +27,14 @@ export class ThemeService {
             prefferedColorSchemeUnsubscribe();
         };
     }
+    onThemeChanged = () => {
+        let currentTheme = this.api.themeApi.getCurrentThemeObject();
+        currentTheme = this.mapOsTheme(currentTheme);
+        this.applyNewThemeVariables(currentTheme);
+        // this needs to be called after variables are set
+        // as it may show the warning for a custom/runtime theme
+        this.showMissingThemeFiles(currentTheme);
+    };
     applyNewThemeVariables(theme) {
         const variables = theme.CSSVariables;
         if (!variables || Object.keys(variables).length === 0) {
@@ -68,15 +70,11 @@ export class ThemeService {
             return val;
         });
         if (abLoaded !== '777') {
-            logger.consoleError('Please import Adaptable styles from "@adaptabletools/adaptable/index.css"');
+            logger.consoleError('Adaptable styles not detected. Please import "@adaptabletools/adaptable/index.css".');
         }
         const isCustomUserTheme = !this.api.themeApi.internalApi.isSystemTheme(themeName);
         if (!isCustomUserTheme && abThemeLoaded !== themeName) {
-            logger.consoleWarn(`Theme "${themeName}" doesn't seem to be loaded! Make sure you import the css file for the "${themeName}" theme!
-
-If it's an AdapTable system theme, try
-
-import "@adaptabletools/adaptable/themes/${themeName}.css"`);
+            logger.consoleWarn(`Theme "${themeName}" does not appear to be loaded. Ensure the CSS file is imported, e.g.: import "@adaptabletools/adaptable/themes/${themeName}.css".`);
         }
     }
     // prefers-color-scheme

package/src/Utilities/Services/ValidationService.js

@@ -4,6 +4,7 @@ import { AlertModuleId } from '../Constants/ModuleConstants';
 import { SERVER_VALIDATION_HEADER, SERVER_VALIDATION_MESSAGE_TYPE, } from '../Constants/GeneralConstants';
 import { errorOnce } from '../../agGrid/AdaptableLogger';
 export class ValidationService {
+    adaptableApi;
     constructor(adaptableApi) {
         this.adaptableApi = adaptableApi;
         this.adaptableApi = adaptableApi;
@@ -52,7 +53,7 @@ export class ValidationService {
             let alert = {
                 alertType: 'cellChanged',
                 header: 'Alert',
-                message: 'Perform Edit Alert Fired',
+                message: 'A validation rule was triggered for this edit.',
                 alertDefinition: failedRules[0],
                 cellDataChangedInfo: cellDataChangedInfo,
             };

package/src/Utilities/createAgStatusPanelComponent.js

@@ -19,6 +19,9 @@ export const createAgStatusPanelComponent = (component, adaptable, context) => {
         };
     }
     return class StatusBarRenderer {
+        params;
+        eGui;
+        unmountReactRoot;
         init(params) {
             this.params = params;
             this.eGui = document.createElement('div');

package/src/Utilities/logDeprecation.js

@@ -11,13 +11,12 @@ const doOnce = (func, key) => {
 };
 export const logDeprecation = (logger, typeName, oldProp, newProp, message) => {
     const newPropMsg = newProp ? `Please use '${typeName}.${newProp}()' instead. ` : '';
-    doOnce(() => logger.consoleWarn(`'${typeName}.${oldProp}()' is deprecated. ${newPropMsg}${message ?? ''}`), `Deprecated_${oldProp}`);
+    doOnce(() => logger.consoleWarn(`${typeName}.${oldProp}() is deprecated. ${newPropMsg}${message ?? ''}`), `Deprecated_${oldProp}`);
 };
 export const logDeprecationExternal = (logger, oldTypeName, oldProp, newTypeName, newProp, message) => {
     const newPropMsg = newProp ? `Please use '${newTypeName}.${newProp}()' instead. ` : '';
-    doOnce(() => logger.consoleWarn(`'${oldTypeName}.${oldProp}()' is deprecated. ${newPropMsg}${message ?? ''}`), `Deprecated_${oldProp}`);
+    doOnce(() => logger.consoleWarn(`${oldTypeName}.${oldProp}() is deprecated. ${newPropMsg}${message ?? ''}`), `Deprecated_${oldProp}`);
 };
 export const logDeprecationInternal = (logger, typeName, oldProp) => {
-    doOnce(() => logger.consoleWarn(`'${typeName}.${oldProp}()' is deprecated. The method will be removed in the next major release.
-        Please contact support if you need the missing functionality.`), `Deprecated_${oldProp}`);
+    doOnce(() => logger.consoleWarn(`${typeName}.${oldProp}() is deprecated and will be removed in the next major release. Contact support if you need this functionality.`), `Deprecated_${oldProp}`);
 };

package/src/Utilities/resolveContainerElement.d.ts

@@ -0,0 +1,23 @@
+import type { AdaptableContainerValue, ContainerContext, InitContainerContext } from '../AdaptableOptions/ContainerOptions';
+/**
+ * The union type representing any container option value (static or function).
+ */
+type AnyContainerOption = AdaptableContainerValue | ((context: any) => AdaptableContainerValue);
+/**
+ * Resolves a container option value to an `HTMLElement`.
+ *
+ * Resolution order:
+ * 1. If `container` is `null`/`undefined`, returns `null`.
+ * 2. If `container` is a function, it is called with the provided `context` and the result is resolved.
+ * 3. If the value is an `HTMLElement`, it is returned directly.
+ * 4. If the value is an `AdaptableCSSSelector` (`{ selector: string }`), `document.querySelectorAll` is used.
+ *    If multiple elements match, the first is returned and a console warning is logged.
+ * 5. If the value is a `string`, it is treated as an element ID and `document.getElementById` is used.
+ *
+ * @param container - The container reference to resolve.
+ * @param context - Optional context passed to the function form of the container.
+ * @param doc - The document to query against (defaults to `globalThis.document`).
+ * @returns The resolved `HTMLElement`, or `null` if not found.
+ */
+export declare function resolveContainerElement(container: AnyContainerOption | undefined | null, context?: ContainerContext | InitContainerContext, doc?: Document): HTMLElement | null;
+export {};

package/src/Utilities/resolveContainerElement.js

@@ -0,0 +1,44 @@
+/**
+ * Resolves a container option value to an `HTMLElement`.
+ *
+ * Resolution order:
+ * 1. If `container` is `null`/`undefined`, returns `null`.
+ * 2. If `container` is a function, it is called with the provided `context` and the result is resolved.
+ * 3. If the value is an `HTMLElement`, it is returned directly.
+ * 4. If the value is an `AdaptableCSSSelector` (`{ selector: string }`), `document.querySelectorAll` is used.
+ *    If multiple elements match, the first is returned and a console warning is logged.
+ * 5. If the value is a `string`, it is treated as an element ID and `document.getElementById` is used.
+ *
+ * @param container - The container reference to resolve.
+ * @param context - Optional context passed to the function form of the container.
+ * @param doc - The document to query against (defaults to `globalThis.document`).
+ * @returns The resolved `HTMLElement`, or `null` if not found.
+ */
+export function resolveContainerElement(container, context, doc = globalThis.document) {
+    if (container == null) {
+        return null;
+    }
+    // Unwrap function form — pass context if the container is a function
+    const value = typeof container === 'function' ? container(context) : container;
+    // Guard against null/undefined returned by a callback (e.g. document.getElementById(...))
+    if (value == null) {
+        return null;
+    }
+    // Direct HTMLElement reference
+    if (value instanceof HTMLElement) {
+        return value;
+    }
+    // CSS Selector object
+    if (typeof value === 'object' && 'selector' in value) {
+        const matches = doc.querySelectorAll(value.selector);
+        if (matches.length > 1) {
+            console.warn(`[AdapTable] CSS selector "${value.selector}" matched ${matches.length} elements. Using the first match. Consider using a more specific selector.`);
+        }
+        return matches[0] ?? null;
+    }
+    // String element ID
+    if (typeof value === 'string') {
+        return doc.getElementById(value);
+    }
+    return null;
+}

package/src/View/AdaptablePopover/index.d.ts

@@ -17,6 +17,7 @@ export interface AdaptablePopoverProps extends React.ClassAttributes<React.Props
     popupPadding?: 0 | 2;
     alignPosition?: OverlayShowParams['alignPosition'];
     visible?: boolean;
+    disabled?: boolean;
 }
 export declare class AdaptablePopover extends React.Component<React.PropsWithChildren<AdaptablePopoverProps>, {}> {
     render(): React.JSX.Element;

package/src/View/AdaptablePopover/index.js

@@ -35,7 +35,7 @@ export class AdaptablePopover extends React.Component {
                 // showTriangle
                 visible: this.props.visible, render: () => popoverClickRootClose, showEvent: (this.props.showEvent || 'mouseenter'), hideEvent: (this.props.hideEvent || 'mouseleave'), style: {
                     overflow: 'visible',
-                }, alignPosition: this.props.alignPosition }, useButton ? (React.createElement(ButtonInfo, { style: iconStyle, variant: "text", onClick: () => null, icon: showIcon && icon, tooltip: this.props.tooltipText }, this.props.children)) : (React.createElement("div", { title: this.props.tooltipText, tabIndex: 0, style: { cursor: 'pointer', display: 'inline-block' } },
+                }, alignPosition: this.props.alignPosition }, useButton ? (React.createElement(ButtonInfo, { style: iconStyle, variant: "text", onClick: () => null, icon: showIcon && icon, tooltip: this.props.tooltipText, disabled: this.props.disabled }, this.props.children)) : (React.createElement("div", { title: this.props.tooltipText, tabIndex: 0, style: { cursor: 'pointer', display: 'inline-block' } },
                 this.props.children,
                 showIcon && React.createElement(Icon, { name: icon, style: iconStyle }))))));
     }

package/src/View/Alert/ActiveAlertsPanel.js

@@ -7,5 +7,13 @@ export const ActiveAlertsPanel = () => {
     const adaptable = useAdaptable();
     const filterModule = adaptable.ModuleService.getModuleById(ModuleConstants.AlertModuleId);
     const alerts = useSelector((state) => state.Internal.AdaptableAlerts);
+    // map the suspended property from the underlying AlertDefinitions
+    alerts.forEach((alert) => {
+        const liveAlertDef = adaptable.api.alertApi.getAlertDefinitionById(alert.alertDefinition.Uuid);
+        if (liveAlertDef) {
+            // @ts-ignore theoretically AdaptableAlert is not Suspendable; practically <AdaptableObjectCompactList> expects it
+            alert.IsSuspended = liveAlertDef.IsSuspended;
+        }
+    });
     return React.createElement(AdaptableObjectCompactList, { abObjects: alerts, module: filterModule });
 };

package/src/View/Alert/AlertViewPanel.js

@@ -2,10 +2,11 @@ import * as React from 'react';
 import { connect } from 'react-redux';
 import * as InternalRedux from '../../Redux/ActionsReducers/InternalRedux';
 import { AdaptablePopover } from '../AdaptablePopover';
-import UIHelper from '../UIHelper';
 import { getAlertButtonStyle } from './Utilities/getAlertButtonStyle';
 import { ActiveAlertsPanel } from './ActiveAlertsPanel';
 import { Flex } from '../../components/Flex';
+import { ButtonClear } from '../Components/Buttons/ButtonClear';
+import clsx from 'clsx';
 class AlertViewPanelComponent extends React.Component {
     constructor(props) {
         super(props);
@@ -20,7 +21,6 @@ class AlertViewPanelComponent extends React.Component {
         }
     }
     render() {
-        const messageType = UIHelper.getMessageTypeFromAdaptableAlerts(this.props.AdaptableAlerts);
         const { color: buttonTextColor, background: buttonBackground } = getAlertButtonStyle(this.props.AdaptableAlerts);
         const collapsedText = this.props.AdaptableAlerts.length == 0
             ? '0 Alerts'
@@ -28,13 +28,17 @@ class AlertViewPanelComponent extends React.Component {
                 ? '1 Alert'
                 : this.props.AdaptableAlerts.length + ' Alerts';
         const alertsPanel = React.createElement(ActiveAlertsPanel, null);
-        const elementType = this.props.viewType === 'Toolbar' ? 'DashboardToolbar' : 'ToolPanel';
-        return (React.createElement(Flex, { alignItems: "stretch", className: `ab-${elementType}__Alert__wrap` },
-            React.createElement(Flex, { className: `ab-${elementType}__Alert__text twa:rounded-standard twa:mr-2 twa:p-2 text-2`, style: { color: buttonTextColor, backgroundColor: buttonBackground }, alignItems: "center" }, collapsedText),
-            this.props.AdaptableAlerts.length > 0 && (React.createElement(Flex, { alignItems: "center" },
-                React.createElement(AdaptablePopover, { className: `ab-${elementType}__Alert__info`, headerText: "", 
-                    // tooltipText="Alerts"
-                    bodyText: [alertsPanel], MessageType: messageType, useButton: true, showEvent: 'focus', hideEvent: "blur", popoverMinWidth: 400 })))));
+        const isToolbar = this.props.viewType === 'Toolbar';
+        const elementType = isToolbar ? 'DashboardToolbar' : 'ToolPanel';
+        return (React.createElement(Flex, { alignItems: "stretch", className: clsx(`ab-${elementType}__Alert__wrap twa:gap-1`, {
+                'twa:min-w-[140px] twa:w-[140px]': isToolbar,
+                [`twa:flex-1`]: !isToolbar,
+            }) },
+            React.createElement(Flex, { key: `${buttonTextColor}_${buttonBackground}_${collapsedText}`, className: `ab-${elementType}__Alert__text twa:flex-1 twa:rounded-standard twa:p-2 text-2 twa:items-center twa:justify-center twa:min-h-input`, style: { color: buttonTextColor, backgroundColor: buttonBackground } }, collapsedText),
+            this.props.AdaptableAlerts.length > 0 && (React.createElement(Flex, { className: 'twa:gap-1' },
+                React.createElement(Flex, { className: "twa:flex twa:box-border" },
+                    React.createElement(ButtonClear, { "aria-label": 'Clear All Alerts', variant: 'outlined', className: `ab-${elementType}__Alert__clear`, onClick: () => this.props.onDeleteAllAlert(this.state.Alerts), tooltip: "Clear All Alerts", showText: this.props.viewType === 'ToolPanel' }, 'Clear Alerts')),
+                React.createElement(AdaptablePopover, { className: `ab-${elementType}__Alert__info`, headerText: "Alerts Details", bodyText: [alertsPanel], MessageType: 'Info', useButton: true, showEvent: 'focus', hideEvent: "blur", popoverMinWidth: 400 })))));
     }
 }
 function mapStateToProps(state, ownProps) {

package/src/View/Alert/Utilities/getAlertButtonStyle.d.ts

@@ -2,4 +2,5 @@ import { AdaptableAlert } from '../../../../types';
 export declare const getAlertButtonStyle: (alerts: AdaptableAlert[]) => {
     color: string;
     background: string;
+    cssClasses: string;
 };

package/src/View/Alert/Utilities/getAlertButtonStyle.js

@@ -4,8 +4,16 @@ export const getAlertButtonStyle = (alerts) => {
     const messageTypeColor = UIHelper.getColorByMessageType(messageType);
     const buttonBackground = UIHelper.getButtonColourForAdaptableAlerts(alerts, messageTypeColor);
     const buttonTextColor = UIHelper.getButtonTextColourForArrayandMessageType(alerts, messageType);
+    let cssClasses = '';
+    if (alerts?.length) {
+        const cssMessageType = UIHelper.getCSSColorByMessageType(messageType);
+        cssClasses = cssMessageType
+            ? `twa:bg-${cssMessageType} twa:text-text-on-${cssMessageType}`
+            : '';
+    }
     return {
         color: buttonTextColor,
         background: buttonBackground,
+        cssClasses,
     };
 };

package/src/View/Alert/Utilities/getDefaultAlertDefinition.d.ts

@@ -6,6 +6,7 @@ import { AlertType } from './getAlertType';
  */
 export declare const getDefaultAlertDefinition: (alertDefinition: AlertDefinition, type: AlertType) => {
     Uuid: string;
+    Name: string;
     Scope: import("../../../types").ColumnScope;
     Rule: import("../../../types").AlertRule;
     MessageType: import("../../../types").AdaptableMessageType;

package/src/View/Alert/Wizard/AlertTypeWizardSection.d.ts

@@ -1,9 +1,12 @@
 import * as React from 'react';
 import { AlertType } from '../Utilities/getAlertType';
+import { AdaptableApi, AlertDefinition } from '../../../types';
+export declare const isSettingsValid: (data: AlertDefinition, api: AdaptableApi) => true | "Name is required" | "An Alert already exists with that name";
 export declare const renderAlertTypeSummary: (alertType: AlertType) => React.JSX.Element;
-type AlertBehaviourWizardSectionProps = {
+type AlertTypeWizardSectionProps = {
     onAlertTypeChange: (alertType: AlertType) => void;
     alertType: AlertType | null;
+    onChange: (data: AlertDefinition) => void;
 };
-export declare const AlertTypeWizardSection: (props: AlertBehaviourWizardSectionProps) => React.JSX.Element;
+export declare const AlertTypeWizardSection: (props: AlertTypeWizardSectionProps) => React.JSX.Element;
 export {};

package/src/View/Alert/Wizard/AlertTypeWizardSection.js

@@ -3,20 +3,55 @@ import { Tabs } from '../../../components/Tabs';
 import { AlertType, getAlertTypeText } from '../Utilities/getAlertType';
 import { TypeRadio } from '../../Wizard/TypeRadio';
 import { Tag } from '../../../components/Tag';
-import { Box, Flex } from '../../../components/Flex';
+import { Flex } from '../../../components/Flex';
+import { useOnePageAdaptableWizardContext } from '../../Wizard/OnePageAdaptableWizard';
+import FormLayout, { FormRow } from '../../../components/FormLayout';
+import Input from '../../../components/Input';
+import { SummaryText } from '../../Wizard/OnePageAdaptableWizard';
+export const isSettingsValid = (data, api) => {
+    if (!data.Name?.trim()) {
+        return 'Name is required';
+    }
+    const allAlerts = api.alertApi.getAlertDefinitions();
+    const isDuplicateName = allAlerts.some((a) => a.Name === data.Name && a.Uuid !== data.Uuid);
+    if (isDuplicateName) {
+        return 'An Alert already exists with that name';
+    }
+    return true;
+};
 export const renderAlertTypeSummary = (alertType) => {
+    const { data } = useOnePageAdaptableWizardContext();
     const text = getAlertTypeText(alertType);
-    return (React.createElement(Box, null,
-        React.createElement(Tag, null, text)));
+    return (React.createElement(React.Fragment, null,
+        React.createElement(SummaryText, null,
+            "Name ",
+            React.createElement(Tag, null, data.Name || 'Not specified')),
+        React.createElement(SummaryText, null,
+            "Type ",
+            React.createElement(Tag, null, text))));
 };
 export const AlertTypeWizardSection = (props) => {
-    return (React.createElement(Tabs, null,
-        React.createElement(Tabs.Tab, null, "Alert Type"),
-        React.createElement(Tabs.Content, null,
-            React.createElement(Flex, { flexDirection: "column" },
-                React.createElement(TypeRadio, { text: getAlertTypeText(AlertType.DataChange), description: "A change has been made to the Grid's underlying data", checked: props.alertType === AlertType.DataChange, onClick: () => props.onAlertTypeChange(AlertType.DataChange) }),
-                React.createElement(TypeRadio, { text: getAlertTypeText(AlertType.RowChange), description: "A Row was added or removed from the data source", checked: props.alertType === AlertType.RowChange, onClick: () => props.onAlertTypeChange(AlertType.RowChange) }),
-                React.createElement(TypeRadio, { text: getAlertTypeText(AlertType.Aggregation), description: "A change has been made to aggregated data (i.e. from multiple Rows)", onClick: () => props.onAlertTypeChange(AlertType.Aggregation), checked: props.alertType === AlertType.Aggregation }),
-                React.createElement(TypeRadio, { text: getAlertTypeText(AlertType.Observable), description: "A specified change (or lack of change) over time has been observed in the Grid", onClick: () => props.onAlertTypeChange(AlertType.Observable), checked: props.alertType === AlertType.Observable }),
-                React.createElement(TypeRadio, { text: getAlertTypeText(AlertType.Validation), description: "A change has broken a data validation rule", checked: props.alertType === AlertType.Validation, onClick: () => props.onAlertTypeChange(AlertType.Validation) })))));
+    const { data } = useOnePageAdaptableWizardContext();
+    const handleNameChange = (event) => {
+        props.onChange({
+            ...data,
+            Name: event.target.value,
+        });
+    };
+    return (React.createElement(Flex, { flexDirection: "column" },
+        React.createElement(Tabs, null,
+            React.createElement(Tabs.Tab, null, "Settings"),
+            React.createElement(Tabs.Content, null,
+                React.createElement(FormLayout, null,
+                    React.createElement(FormRow, { label: "Name" },
+                        React.createElement(Input, { "data-name": "alert-name", className: "twa:flex-1 twa:max-w-[200px] twa:mr-3", onChange: handleNameChange, placeholder: "Enter Name", value: data.Name ?? '' }))))),
+        React.createElement(Tabs, { className: "twa:mt-2" },
+            React.createElement(Tabs.Tab, null, "Alert Type"),
+            React.createElement(Tabs.Content, null,
+                React.createElement(Flex, { flexDirection: "column" },
+                    React.createElement(TypeRadio, { text: getAlertTypeText(AlertType.DataChange), description: "A change has been made to the Grid's underlying data", checked: props.alertType === AlertType.DataChange, onClick: () => props.onAlertTypeChange(AlertType.DataChange) }),
+                    React.createElement(TypeRadio, { text: getAlertTypeText(AlertType.RowChange), description: "A Row was added or removed from the data source", checked: props.alertType === AlertType.RowChange, onClick: () => props.onAlertTypeChange(AlertType.RowChange) }),
+                    React.createElement(TypeRadio, { text: getAlertTypeText(AlertType.Aggregation), description: "A change has been made to aggregated data (i.e. from multiple Rows)", onClick: () => props.onAlertTypeChange(AlertType.Aggregation), checked: props.alertType === AlertType.Aggregation }),
+                    React.createElement(TypeRadio, { text: getAlertTypeText(AlertType.Observable), description: "A specified change (or lack of change) over time has been observed in the Grid", onClick: () => props.onAlertTypeChange(AlertType.Observable), checked: props.alertType === AlertType.Observable }),
+                    React.createElement(TypeRadio, { text: getAlertTypeText(AlertType.Validation), description: "A change has broken a data validation rule", checked: props.alertType === AlertType.Validation, onClick: () => props.onAlertTypeChange(AlertType.Validation) }))))));
 };

package/src/View/Alert/Wizard/AlertWizard.js

@@ -1,5 +1,5 @@
 import * as React from 'react';
-import { useState } from 'react';
+import { useState, useCallback } from 'react';
 import { OnePageAdaptableWizard, OnePageWizardSummary } from '../../Wizard/OnePageAdaptableWizard';
 import { cloneObject } from '../../../Utilities/Helpers/Helper';
 import { AlertScopeWizardSection } from './AlertScopeWizardSection';
@@ -15,7 +15,7 @@ import { useDispatch } from 'react-redux';
 import * as AlertRedux from '../../../Redux/ActionsReducers/AlertRedux';
 import { useAdaptable } from '../../AdaptableContext';
 import { ObjectTagsWizardSection, renderObjectTagsSummary, } from '../../Wizard/ObjectTagsWizardSection';
-import { AlertTypeWizardSection, renderAlertTypeSummary } from './AlertTypeWizardSection';
+import { AlertTypeWizardSection, renderAlertTypeSummary, isSettingsValid, } from './AlertTypeWizardSection';
 import { AlertType, getAlertType } from '../Utilities/getAlertType';
 import { mapAlertDefinition } from '../Utilities/mapAlertDefinition';
 import { getDefaultAlertDefinition } from '../Utilities/getDefaultAlertDefinition';
@@ -25,7 +25,7 @@ export const AlertWizard = (props) => {
     const { api } = useAdaptable();
     const dispatch = useDispatch();
     const behaviourSpelling = api.internalApi.getCorrectEnglishVariant('Behaviour');
-    const [alertDefinition, setAlertDefinition] = useState(() => {
+    const [alertDefinition, doSetAlertDefinition] = useState(() => {
         const alertDefinition = props.data
             ? cloneObject(props.data)
             : ObjectFactory.CreateEmptyAlertDefinition();
@@ -45,6 +45,9 @@ export const AlertWizard = (props) => {
         alertDefinition.MessageType = alertDefinition.MessageType ?? ALERT_DEFAULT_MESSAGE_TYPE;
         return alertDefinition;
     });
+    const setAlertDefinition = useCallback((data) => {
+        doSetAlertDefinition(data);
+    }, []);
     // Alert type is based initialy on data, but can be changed by the user
     // the default objects do not neccesary have enough information to determine the type
     const [alertType, setAlertType] = useState(() => {
@@ -59,22 +62,23 @@ export const AlertWizard = (props) => {
         }
         props.onCloseWizard();
     };
-    const updateAlertDefinition = (newAlertDefinition) => {
-        setAlertDefinition(mapAlertDefinition(api, newAlertDefinition));
-    };
+    const updateAlertDefinition = useCallback((newAlertDefinition) => {
+        doSetAlertDefinition(mapAlertDefinition(api, newAlertDefinition));
+    }, [api]);
     const handleAlertTypeChange = (newAlertType) => {
         setAlertType(newAlertType);
-        setAlertDefinition(getDefaultAlertDefinition(alertDefinition, newAlertType));
+        doSetAlertDefinition(getDefaultAlertDefinition(alertDefinition, newAlertType));
     };
     return (React.createElement(OnePageAdaptableWizard, { defaultCurrentSectionName: props.defaultCurrentSectionName, moduleInfo: props.moduleInfo, modal: props.modal, data: alertDefinition, onHide: props.onCloseWizard, onFinish: handleFinish, sections: [
             {
-                title: 'Type',
+                title: 'Name & Type',
+                isValid: isSettingsValid,
                 details: (React.createElement(React.Fragment, null,
-                    "Select ",
+                    "Enter Name and select ",
                     React.createElement("b", null, "what"),
                     " type of change in AdapTable will cause the Alert to fire")),
                 render: () => (React.createElement(Box, { className: "twa:p-2" },
-                    React.createElement(AlertTypeWizardSection, { alertType: alertType, onAlertTypeChange: handleAlertTypeChange }))),
+                    React.createElement(AlertTypeWizardSection, { alertType: alertType, onAlertTypeChange: handleAlertTypeChange, onChange: setAlertDefinition }))),
                 renderSummary: () => renderAlertTypeSummary(alertType),
             },
             {