@adaptabletools/adaptable 11.1.2 → 11.1.5

package/src/agGrid/Adaptable.js

@@ -57,6 +57,7 @@ const MetamodelService_1 = require("../Utilities/Services/MetamodelService");
 const DocumentationLinkConstants_1 = require("../Utilities/Constants/DocumentationLinkConstants");
 const ModuleConstants_1 = require("../Utilities/Constants/ModuleConstants");
 const CheckboxRenderer_1 = require("./CheckboxRenderer");
+const DateHelper_1 = require("../Utilities/Helpers/DateHelper");
 const tinycolor = require('tinycolor2');
 all_modules_1.ModuleRegistry.registerModules(all_modules_1.AllCommunityModules);
 const GROUP_PATH_SEPARATOR = '/';
@@ -343,15 +344,15 @@ class Adaptable {
         this.initStore();
         // create the services
         this.LicenseService = this.initLicenseService();
-        this.ValidationService = new ValidationService_1.ValidationService(this);
-        this.ReportService = new ReportService_1.ReportService(this);
-        this.ModuleService = new ModuleService_1.ModuleService(this);
-        this.CalculatedColumnExpressionService = new CalculatedColumnExpressionService_1.CalculatedColumnExpressionService(this);
-        this.EntitlementService = new EntitlementService_1.EntitlementService(this);
-        this.QueryLanguageService = new QueryLanguageService_1.QueryLanguageService(this);
-        this.AlertService = new AlertService_1.AlertService(this);
-        this.TeamSharingService = new TeamSharingService_1.TeamSharingService(this);
-        this.MetamodelService = new MetamodelService_1.MetamodelService(this);
+        this.ValidationService = new ValidationService_1.ValidationService(this.api);
+        this.ReportService = new ReportService_1.ReportService(this.api);
+        this.ModuleService = new ModuleService_1.ModuleService(this.api);
+        this.CalculatedColumnExpressionService = new CalculatedColumnExpressionService_1.CalculatedColumnExpressionService(this.api);
+        this.EntitlementService = new EntitlementService_1.EntitlementService(this.api);
+        this.QueryLanguageService = new QueryLanguageService_1.QueryLanguageService(this.api);
+        this.AlertService = new AlertService_1.AlertService(this.api);
+        this.TeamSharingService = new TeamSharingService_1.TeamSharingService(this.api);
+        this.MetamodelService = new MetamodelService_1.MetamodelService(this.api);
         this.forPlugins((plugin) => plugin.afterInitServices(this));
         // Set up Modules - we set up all the Modules suitable for AG Grid
         // But users can make some hidden or readonly in their entitlements
@@ -903,6 +904,20 @@ class Adaptable {
                 ? flashingCell.flashingCellDefinition.DownChangeStyle
                 : flashingCell.flashingCellDefinition.NeutralChangeStyle)) !== null && _a !== void 0 ? _a : {});
     }
+    getFlashingCellClass(col, params) {
+        var _a, _b, _c;
+        const primaryKey = params.node.aggData
+            ? params.node.id
+            : this.getPrimaryKeyValueFromRowNode(params.node);
+        const flashingCell = this.api.internalApi.getAdaptableFlashingCellFor(primaryKey, col.columnId);
+        if (!flashingCell) {
+            return;
+        }
+        return flashingCell.direction === 'up'
+            ? (_a = flashingCell.flashingCellDefinition.UpChangeStyle) === null || _a === void 0 ? void 0 : _a.ClassName : flashingCell.direction === 'down'
+            ? (_b = flashingCell.flashingCellDefinition.DownChangeStyle) === null || _b === void 0 ? void 0 : _b.ClassName : flashingCell.direction === 'neutral'
+            ? (_c = flashingCell.flashingCellDefinition.NeutralChangeStyle) === null || _c === void 0 ? void 0 : _c.ClassName : undefined;
+    }
     getCellHighlightStyle(col, params) {
         const primaryKeyValue = this.getPrimaryKeyValueFromRowNode(params.node);
         const cellHightlight = this.api.internalApi
@@ -994,8 +1009,7 @@ class Adaptable {
                 return (_b = conditionalStyle.Style) === null || _b === void 0 ? void 0 : _b.ClassName;
             }
         })
-            .filter((x) => !!x)
-            .join(' ');
+            .filter((x) => !!x);
         return classNames;
     }
     getEditableCellClass(abColumn, params) {
@@ -1678,27 +1692,27 @@ class Adaptable {
             return undefined;
         }
     }
-    isInternallyRenderedColumn(column) {
+    isCustomRenderedColumn(column) {
         if (!column || column.isGrouped) {
-            return true;
+            return false;
         }
-        // we need to return false if the column has a cell rendeerer i think...
+        // we need to return false if the column has a cell renderer i think...
         const colDef = this.gridOptions.api.getColumnDef(column.columnId);
         if (colDef && colDef.cellRenderer != null) {
-            return false;
+            return true;
         }
         if (this.api.columnApi.isFormatNumericStyleColumn(column)) {
-            return false;
+            return true;
         }
         if (this.api.columnApi.isBooleanColumn(column)) {
-            return false;
+            return true;
         }
-        return true;
+        return false;
     }
-    getDisplayValue(id, columnId) {
+    getDisplayValue(primaryKey, columnId) {
         let returnValue;
         if (this.useRowNodeLookUp) {
-            const rowNode = this.gridOptions.api.getRowNode(id);
+            const rowNode = this.getRowNodeForPrimaryKey(primaryKey);
             return this.getDisplayValueFromRowNode(rowNode, columnId);
         }
         else {
@@ -1706,7 +1720,7 @@ class Adaptable {
             this.gridOptions.api.getModel().forEachNode((rowNode) => {
                 if (!foundRow) {
                     const primaryKeyValue = this.getPrimaryKeyValueFromRowNode(rowNode);
-                    if (id == primaryKeyValue) {
+                    if (primaryKey == primaryKeyValue) {
                         returnValue = this.getDisplayValueFromRowNode(rowNode, columnId);
                     }
                     foundRow = true;
@@ -1789,10 +1803,17 @@ class Adaptable {
         return formatterFn(params);
     }
     getNormalisedValueFromRowValue(rawValue, displayValue, column) {
+        // not sure if the current implementation is correct:
+        // the returned "normalised value" is actually the displayed value in almost all cases?!
+        // ex. how to read the following: if 'rawValue' is NOT a number, return normalised version of rawValue, but if rawValue IS a number, return displayedValue of it (which will almost certainly will NOT be a number)
+        //   if (dataType === 'Number') {
+        //     return typeof rawValue !== 'number' ? Number(rawValue) : returnValue;
+        //   }
+        // anyway, it seems to work so far (as of v11.1.3), so I'm leaving it for now :)
         if (!column) {
             return rawValue;
         }
-        const returnValue = this.isInternallyRenderedColumn(column) ? displayValue : rawValue;
+        const returnValue = this.isCustomRenderedColumn(column) ? rawValue : displayValue;
         if (returnValue === undefined || returnValue === null) {
             return rawValue;
         }
@@ -1806,13 +1827,15 @@ class Adaptable {
         if (dataType === 'Boolean') {
             return typeof rawValue !== 'boolean' ? Boolean(rawValue) : returnValue;
         }
-        // Do not normalize dates to Date type
-        // - breaks when rendering in filter-form
-        // - breaks quick-search; the Date is transformed to string;
-        // -- an incorrect comparison is made (new Date().toString).incudes('query)
+        if (dataType === 'Date') {
+            return rawValue instanceof Date ? rawValue : DateHelper_1.parseDateValue(rawValue);
+        }
         return returnValue;
     }
     getRawValueFromRowNode(rowNode, columnId) {
+        if (rowNode == null) {
+            return undefined;
+        }
         return this.gridOptions.api.getValue(columnId, rowNode);
     }
     getDataRowFromRowNode(rowNode) {
@@ -2092,7 +2115,10 @@ class Adaptable {
                     if (newlyCreatedSpecialColDef) {
                         // if it's a special column and we have a special col def for it, return the special col def
                         processedSpecialColDefIds.push(colDef.colId);
-                        return newlyCreatedSpecialColDef;
+                        // merge the user defined colDef with the special col def
+                        // this way the user may provide some custom settings for the special col def (tooltip, etc)
+                        const mergedColDef = Object.assign(Object.assign({}, colDef), newlyCreatedSpecialColDef);
+                        return mergedColDef;
                     }
                     else {
                         // otherwise, return the original col def
@@ -2841,14 +2867,13 @@ class Adaptable {
             const hasConditionalStylesWithClassNames = ArrayExtensions_1.ArrayExtensions.IsNotNullOrEmpty(conditionalStyles);
             const quickSearchStyleClassName = this.api.quickSearchApi.getQuickSearchStyle().ClassName;
             const hasQuickSearchStyleClassName = StringExtensions_1.StringExtensions.IsNotNullOrEmpty(quickSearchStyleClassName);
-            const classNameMap = {};
             const cellClass = (params) => {
-                var _a;
                 const isQuickSearchActive = hasQuickSearchStyleClassName && this.isQuickSearchActive(abColumn, params);
                 const primaryKeyValue = this.getPrimaryKeyValueFromRowNode(params.node);
                 const editableClassName = this.getEditableCellClass(abColumn, params);
                 const readonlyClassName = this.getReadonlyCellClass(abColumn, params);
                 const highlightAlertClassName = this.getAlertCellClass(abColumn, params);
+                const flashingClassName = this.getFlashingCellClass(abColumn, params);
                 const returnValue = [
                     this.getExcelClassNameForCell(colId, primaryKeyValue),
                     typeof userCellClass === 'function' ? userCellClass(params) : userCellClass,
@@ -2860,29 +2885,11 @@ class Adaptable {
                     editableClassName,
                     readonlyClassName,
                     highlightAlertClassName,
+                    flashingClassName,
                 ]
-                    // we flatten the array because 'userCellClass' might return a string[]
+                    // we flatten the array because some rules ('userCellClass',conditionalStyles etc)  might return a string[]
                     .flat()
                     .filter((x) => !!x);
-                const returnValueHash = returnValue.join(' ');
-                const primaryKey = this.getPrimaryKeyValueFromRowNode(params.node);
-                const key = `${primaryKey}:${params.colDef.colId}`;
-                if (classNameMap[key] &&
-                    classNameMap[key] !== returnValueHash &&
-                    // only hard-reset when removing class-names
-                    // ag-grid does not remove class-names, it accumulates them
-                    // https://www.ag-grid.com/javascript-data-grid/cell-styles/#refresh-of-styles
-                    returnValueHash.length < ((_a = classNameMap[key]) === null || _a === void 0 ? void 0 : _a.length)) {
-                    setTimeout(() => {
-                        /**
-                         * This is called inside a getter function, inside ag-grid.
-                         * To allow ag-grid run it's logic, the redraw is done inside an timeout
-                         * to make sure it is not done in an inappropriate time.
-                         */
-                        params.api.redrawRows({ rowNodes: [params.node] });
-                    }, 0);
-                }
-                classNameMap[key] = returnValueHash;
                 return returnValue.length ? returnValue : undefined;
             };
             return cellClass;

package/src/components/StylePreview.js

@@ -6,6 +6,6 @@ const React = tslib_1.__importStar(require("react"));
 const rebass_1 = require("rebass");
 const StyleHelper_1 = require("../Utilities/Helpers/StyleHelper");
 exports.StylePreview = (props) => {
-    var _a;
-    return (React.createElement(rebass_1.Box, Object.assign({}, props, { padding: 2, mt: 2, style: Object.assign(Object.assign({}, StyleHelper_1.toStyle(props.styleObject)), props.style) }), (_a = props.children) !== null && _a !== void 0 ? _a : 'Preview result'));
+    var _a, _b, _c;
+    return (React.createElement(rebass_1.Box, Object.assign({}, props, { padding: (_a = props.padding) !== null && _a !== void 0 ? _a : 2, mt: (_b = props.mt) !== null && _b !== void 0 ? _b : 2, style: Object.assign(Object.assign({}, StyleHelper_1.toStyle(props.styleObject)), props.style) }), (_c = props.children) !== null && _c !== void 0 ? _c : 'Preview result'));
 };

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

@@ -3601,6 +3601,11 @@ export declare const ADAPTABLE_METAMODEL: {
             isOptional: boolean;
         }[];
     };
+    TOAST_POSITIONS: {
+        name: string;
+        kind: string;
+        description: string;
+    };
     ToolPanelApi: {
         name: string;
         kind: string;

package/src/metamodel/adaptable.metamodel.js

@@ -3574,7 +3574,7 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "agGridContainerWaitTimeout",
                 "kind": "number",
-                "description": "how long AdapTable waits for AG Grid before giving up connecting to it; useful when AG Grid is instantiated separately (eg: by AdapTable React or AdapTable Angular)",
+                "description": "How long AdapTable waits for AG Grid before giving up connecting to it",
                 "uiLabel": "Ag Grid Container Wait Timeout",
                 "isOptional": true,
                 "gridInfo": "item",
@@ -4287,7 +4287,7 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "buttonsLocation",
                 "kind": "unknown",
-                "description": "Position in the Dashboard to show the Module and Custom Buttons",
+                "description": "Where in Dashboard to display Module and Custom Buttons",
                 "uiLabel": "Buttons Location",
                 "isOptional": true,
                 "defaultValue": "'right'"
@@ -8599,12 +8599,12 @@ exports.ADAPTABLE_METAMODEL = {
                 "isOptional": true,
                 "gridInfo": "item",
                 "defaultValue": "'BottomRight'",
-                "reference": "unknown"
+                "reference": "TOAST_POSITIONS"
             },
             {
                 "name": "showApplicationIcon",
                 "kind": "boolean",
-                "description": "Displays the application icon in Notifications (if provided in `UserInterfaceOptions`)",
+                "description": "Displays the application icon in Notifications",
                 "uiLabel": "Show Application Icon",
                 "isOptional": true,
                 "defaultValue": "false"
@@ -8621,7 +8621,7 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "showSystemStatusMessageNotifications",
                 "kind": "boolean",
-                "description": "Display an Alert when a System Status Message is set",
+                "description": "Display System Status Messages as Notifications",
                 "uiLabel": "Show System Status Message Notifications",
                 "isOptional": true,
                 "gridInfo": "item",
@@ -11070,6 +11070,12 @@ exports.ADAPTABLE_METAMODEL = {
                 "description": "Applies the Current Theme",
                 "uiLabel": "Apply Current Theme"
             },
+            {
+                "name": "getAgGridCurrentThemeName",
+                "kind": "function",
+                "description": "Get the name of the current AG Grid theme",
+                "uiLabel": "Get Ag Grid Current Theme Name"
+            },
             {
                 "name": "getAllSystemTheme",
                 "kind": "function",
@@ -11179,6 +11185,11 @@ exports.ADAPTABLE_METAMODEL = {
             }
         ]
     },
+    "TOAST_POSITIONS": {
+        "name": "TOAST_POSITIONS",
+        "kind": "TypeAlias",
+        "description": "Different positions offered by Notifications"
+    },
     "ToolPanelApi": {
         "name": "ToolPanelApi",
         "kind": "Interface",

package/src/types.d.ts

@@ -9,7 +9,7 @@ export type { AdaptableOptions } from './AdaptableOptions/AdaptableOptions';
 export { AdaptablePlugin } from './AdaptableOptions/AdaptablePlugin';
 export type { ContainerOptions } from './AdaptableOptions/ContainerOptions';
 export type { FlashingCellOptions } from './AdaptableOptions/FlashingCellOptions';
-export type { NotificationsOptions } from './AdaptableOptions/NotificationsOptions';
+export type { TOAST_POSITIONS, NotificationsOptions, } from './AdaptableOptions/NotificationsOptions';
 export type { AlertOptions, ActionHandler, AlertForm, AlertButtonContext, } from './AdaptableOptions/AlertOptions';
 export type { DashboardOptions, CustomToolbar, DashboardButtonContext, CustomToolbarButtonContext, } from './AdaptableOptions/DashboardOptions';
 export type { EditOptions, ValidationResult } from './AdaptableOptions/EditOptions';

package/version.d.ts

@@ -1,2 +1,2 @@
-declare const _default: "11.1.2";
+declare const _default: "11.1.5";
 export default _default;

package/version.js

@@ -1,3 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = '11.1.2'; // PLEASE DONT UPDATE THIS!!! - will be updated at build time with the correct version
+exports.default = '11.1.5'; // PLEASE DONT UPDATE THIS!!! - will be updated at build time with the correct version

package/src/View/Export/ExportCustomDestinationDialog.d.ts

@@ -1,11 +0,0 @@
-/// <reference types="react" />
-import { CustomDestination } from '../../AdaptableOptions/ExportOptions';
-import { Report } from '../../PredefinedConfig/ExportState';
-interface ExportCustomDestinationDialogProps {
-    report: Report;
-    customDestination: CustomDestination;
-    isOpen: boolean;
-    onDismiss: () => void;
-}
-export declare function ExportCustomDestinationDialog({ report, customDestination, isOpen, onDismiss, }: ExportCustomDestinationDialogProps): JSX.Element;
-export {};

package/src/View/Export/ExportCustomDestinationDialog.js

@@ -1,47 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ExportCustomDestinationDialog = void 0;
-const tslib_1 = require("tslib");
-const React = tslib_1.__importStar(require("react"));
-const rebass_1 = require("rebass");
-const AdaptableForm_1 = require("../../PredefinedConfig/Common/AdaptableForm");
-const Dialog_1 = tslib_1.__importDefault(require("../../components/Dialog"));
-const AdaptableFormComponent_1 = require("../../components/AdaptableFormComponent");
-const AdaptableContext_1 = require("../AdaptableContext");
-function ExportCustomDestinationDialog({ report, customDestination, 
-//onSubmit,
-isOpen, onDismiss, }) {
-    const [data, setData] = React.useState({});
-    const adaptable = AdaptableContext_1.useAdaptable();
-    const context = React.useMemo(() => {
-        return {
-            adaptableApi: adaptable.api,
-            report,
-            reportData: undefined,
-            customDestination,
-            formData: data,
-        };
-    }, [data]);
-    const formDef = customDestination === null || customDestination === void 0 ? void 0 : customDestination.form;
-    React.useEffect(() => {
-        if (formDef) {
-            setData(Object.assign(Object.assign({}, AdaptableForm_1.getDefaultAdaptableFormData(formDef)), data));
-        }
-    }, [formDef]);
-    return (React.createElement(Dialog_1.default, { isOpen: isOpen, showCloseButton: false, style: { minHeight: 'auto', minWidth: 400 }, onDismiss: () => {
-            onDismiss();
-        } }, isOpen && (React.createElement(rebass_1.Box, { padding: 4 },
-        React.createElement(AdaptableFormComponent_1.AdaptableFormComponent, { formDef: formDef, data: data, context: context, onChange: setData, api: adaptable.api, displayTitle: true, onButtonClick: (button) => {
-                onDismiss();
-                // we want to give the current popup time to close
-                // and we reopen with a delay in case this button action causes another popup
-                setTimeout(() => {
-                    var _a;
-                    context.reportData = adaptable.api.internalApi
-                        .getReportService()
-                        .getReportData(report);
-                    (_a = button.onClick) === null || _a === void 0 ? void 0 : _a.call(button, button, context);
-                }, 20);
-            } })))));
-}
-exports.ExportCustomDestinationDialog = ExportCustomDestinationDialog;

package/src/View/Export/ExportCustomDestinationFormPopups.d.ts

@@ -1,5 +0,0 @@
-import * as React from 'react';
-import { AdaptableApi } from '../../types';
-export declare const ExportCustomDestinationFormPopups: React.FunctionComponent<{
-    api: AdaptableApi;
-}>;

package/src/View/Export/ExportCustomDestinationFormPopups.js

@@ -1,15 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ExportCustomDestinationFormPopups = void 0;
-const tslib_1 = require("tslib");
-const React = tslib_1.__importStar(require("react"));
-const react_redux_1 = require("react-redux");
-const SystemRedux = tslib_1.__importStar(require("../../Redux/ActionsReducers/SystemRedux"));
-const ExportCustomDestinationDialog_1 = require("./ExportCustomDestinationDialog");
-exports.ExportCustomDestinationFormPopups = (props) => {
-    var _a;
-    const dispatch = react_redux_1.useDispatch();
-    const customDestinationPopups = react_redux_1.useSelector(SystemRedux.getSystemExportCustomDestinationPopups);
-    const handleDismiss = React.useCallback((config) => dispatch(SystemRedux.SystemExportCustomDestinationPopupHide(config)), []);
-    return (React.createElement(React.Fragment, null, (_a = (customDestinationPopups || [])) === null || _a === void 0 ? void 0 : _a.map((customDestinationPopup) => customDestinationPopup && (React.createElement(ExportCustomDestinationDialog_1.ExportCustomDestinationDialog, { isOpen: true, key: `${customDestinationPopup.ReportName}-${customDestinationPopup.ExportDestination.name}`, report: props.api.exportApi.getReportByName(customDestinationPopup.ReportName), customDestination: customDestinationPopup.ExportDestination, onDismiss: () => handleDismiss(customDestinationPopup) })))));
-};