@adaptabletools/adaptable 11.0.9 → 11.1.0

package/src/components/WindowModal/useStacking.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Used to facilitate the stacking between multiple opened windows.
+ * When calling 'bringToFront' brings caller to top.
+ * This is done by changing the zIndex of all registered window-modals.
+ */
+export declare const useStacking: () => {
+    zIndex: number;
+    bringInFront: () => void;
+};

package/src/components/WindowModal/useStacking.js

@@ -0,0 +1,45 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useStacking = void 0;
+const tslib_1 = require("tslib");
+const React = tslib_1.__importStar(require("react"));
+const uuid_1 = tslib_1.__importDefault(require("uuid"));
+const setZIndexMap = {};
+const zIndexMap = [];
+const BASE_Z_INDEX = 1000;
+/**
+ * Used to facilitate the stacking between multiple opened windows.
+ * When calling 'bringToFront' brings caller to top.
+ * This is done by changing the zIndex of all registered window-modals.
+ */
+exports.useStacking = () => {
+    const modalZIndexId = React.useMemo(() => uuid_1.default(), []);
+    const [zIndex, setZIndex] = React.useState(BASE_Z_INDEX);
+    React.useEffect(() => {
+        setZIndexMap[modalZIndexId] = setZIndex;
+        return () => {
+            // clean-up
+            delete setZIndexMap[modalZIndexId];
+            const indexInMap = zIndexMap.indexOf(modalZIndexId);
+            zIndexMap.splice(indexInMap, 1);
+        };
+    }, [modalZIndexId]);
+    const bringInFront = React.useCallback(() => {
+        if (zIndexMap.includes(modalZIndexId)) {
+            const indexInMap = zIndexMap.indexOf(modalZIndexId);
+            zIndexMap.splice(indexInMap, 1);
+            zIndexMap.push(modalZIndexId);
+        }
+        else {
+            zIndexMap.push(modalZIndexId);
+        }
+        zIndexMap.forEach((id, index) => {
+            var _a;
+            (_a = setZIndexMap === null || setZIndexMap === void 0 ? void 0 : setZIndexMap[id]) === null || _a === void 0 ? void 0 : _a.call(setZIndexMap, BASE_Z_INDEX + index * 10);
+        });
+    }, []);
+    return {
+        zIndex,
+        bringInFront,
+    };
+};

package/src/env.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.default = {
-    IPUSHPULL_API_KEY: "CbBaMaoqHVifScrYwKssGnGyNkv5xHOhQVGm3cYP",
-    IPUSHPULL_API_SECRET: "xYzE51kuHyyt9kQCvMe0tz0H2sDSjyEQcF5SOBlPQmcL9em0NqcCzyqLYj5fhpuZxQ8BiVcYl6zoOHeI6GYZj1TkUiiLVFoW3HUxiCdEUjlPS8Vl2YHUMEPD5qkLYnGj",
-    INFINITE_TABLE_LICENSE_KEY: "StartDate=2021-06-29|EndDate=2030-01-01|Owner=Adaptable|Type=distribution|TS=1624971462479|C=137829811,1004007071,2756196225,1839832928,3994409405,636616862",
+    IPUSHPULL_API_KEY: 'CbBaMaoqHVifScrYwKssGnGyNkv5xHOhQVGm3cYP',
+    IPUSHPULL_API_SECRET: 'xYzE51kuHyyt9kQCvMe0tz0H2sDSjyEQcF5SOBlPQmcL9em0NqcCzyqLYj5fhpuZxQ8BiVcYl6zoOHeI6GYZj1TkUiiLVFoW3HUxiCdEUjlPS8Vl2YHUMEPD5qkLYnGj',
+    INFINITE_TABLE_LICENSE_KEY: 'StartDate=2021-06-29|EndDate=2030-01-01|Owner=Adaptable|Type=distribution|TS=1624971462479|C=137829811,1004007071,2756196225,1839832928,3994409405,636616862',
 };

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

@@ -78,27 +78,23 @@ export declare const ADAPTABLE_METAMODEL: {
         name: string;
         kind: string;
         description: string;
+    };
+    AdaptableAlertBase: {
+        name: string;
+        kind: string;
+        description: string;
         properties: ({
             name: string;
             kind: string;
             description: string;
             uiLabel: string;
             reference: string;
-            isOptional?: undefined;
-        } | {
-            name: string;
-            kind: string;
-            description: string;
-            uiLabel: string;
-            isOptional: boolean;
-            reference: string;
         } | {
             name: string;
             kind: string;
             description: string;
             uiLabel: string;
             reference?: undefined;
-            isOptional?: undefined;
         })[];
     };
     AdaptableAlertQuery: {
@@ -149,6 +145,18 @@ export declare const ADAPTABLE_METAMODEL: {
         kind: string;
         description: string;
     };
+    AdaptableCellChangedAlert: {
+        name: string;
+        kind: string;
+        description: string;
+        properties: {
+            name: string;
+            kind: string;
+            description: string;
+            uiLabel: string;
+            reference: string;
+        }[];
+    };
     AdaptableColumn: {
         name: string;
         kind: string;
@@ -514,6 +522,18 @@ export declare const ADAPTABLE_METAMODEL: {
             reference: string;
         }[];
     };
+    AdaptableRowChangedAlert: {
+        name: string;
+        kind: string;
+        description: string;
+        properties: {
+            name: string;
+            kind: string;
+            description: string;
+            uiLabel: string;
+            reference: string;
+        }[];
+    };
     AdaptableScope: {
         name: string;
         kind: string;
@@ -832,6 +852,18 @@ export declare const ADAPTABLE_METAMODEL: {
             isOptional: boolean;
         }[];
     };
+    BaseMenuContext: {
+        name: string;
+        kind: string;
+        description: string;
+        properties: {
+            name: string;
+            kind: string;
+            description: string;
+            uiLabel: string;
+            reference: string;
+        }[];
+    };
     BulkUpdateApi: {
         name: string;
         kind: string;
@@ -2643,7 +2675,7 @@ export declare const ADAPTABLE_METAMODEL: {
         name: string;
         kind: string;
         description: string;
-        properties: {
+        properties: ({
             name: string;
             kind: string;
             description: string;
@@ -2651,7 +2683,15 @@ export declare const ADAPTABLE_METAMODEL: {
             isOptional: boolean;
             gridInfo: string;
             defaultValue: string;
-        }[];
+        } | {
+            name: string;
+            kind: string;
+            description: string;
+            uiLabel: string;
+            isOptional: boolean;
+            gridInfo?: undefined;
+            defaultValue?: undefined;
+        })[];
     };
     LayoutState: {
         name: string;

package/src/metamodel/adaptable.metamodel.js

@@ -5,7 +5,7 @@ exports.ADAPTABLE_METAMODEL = {
     "AccessLevel": {
         "name": "AccessLevel",
         "kind": "TypeAlias",
-        "description": "Defines Access Level for an Entitlement - can be 'ReadOnly', 'Hidden' or 'Full'"
+        "description": "Defines Access Level for an Entitlement - can be `ReadOnly`, `Hidden` or `Full`"
     },
     "ActionColumn": {
         "name": "ActionColumn",
@@ -120,8 +120,13 @@ exports.ADAPTABLE_METAMODEL = {
     },
     "AdaptableAlert": {
         "name": "AdaptableAlert",
+        "kind": "TypeAlias",
+        "description": "Defines an Alert fired by AdapTable"
+    },
+    "AdaptableAlertBase": {
+        "name": "AdaptableAlertBase",
         "kind": "Interface",
-        "description": "Defines an Alert fired by AdapTable",
+        "description": "Defines the base(common) properties of an Alert fired by AdapTable, regardless of the type of change",
         "properties": [
             {
                 "name": "alertDefinition",
@@ -131,12 +136,10 @@ exports.ADAPTABLE_METAMODEL = {
                 "reference": "AlertDefinition"
             },
             {
-                "name": "dataChangedInfo",
-                "kind": "REFERENCE",
-                "description": "DataChange which triggered Alert",
-                "uiLabel": "Data Changed Info",
-                "isOptional": true,
-                "reference": "DataChangedInfo"
+                "name": "alertType",
+                "kind": "unknown",
+                "description": "The type of Alert",
+                "uiLabel": "Alert Type"
             },
             {
                 "name": "header",
@@ -484,6 +487,20 @@ exports.ADAPTABLE_METAMODEL = {
         "kind": "TypeAlias",
         "description": "Calculated Column Query which may be a Scalar or an AggregatedScalar Expression"
     },
+    "AdaptableCellChangedAlert": {
+        "name": "AdaptableCellChangedAlert",
+        "kind": "Interface",
+        "description": "Defines an Alert fired by AdapTable when a cell is changed",
+        "properties": [
+            {
+                "name": "dataChangedInfo",
+                "kind": "REFERENCE",
+                "description": "Cell DataChange which triggered Alert",
+                "uiLabel": "Data Changed Info",
+                "reference": "DataChangedInfo"
+            }
+        ]
+    },
     "AdaptableColumn": {
         "name": "AdaptableColumn",
         "kind": "Interface",
@@ -1347,6 +1364,20 @@ exports.ADAPTABLE_METAMODEL = {
             }
         ]
     },
+    "AdaptableRowChangedAlert": {
+        "name": "AdaptableRowChangedAlert",
+        "kind": "Interface",
+        "description": "Defines an Alert fired by AdapTable when a row is changed",
+        "properties": [
+            {
+                "name": "gridDataChangedInfo",
+                "kind": "REFERENCE",
+                "description": "Row DataChange which triggered Alert",
+                "uiLabel": "Grid Data Changed Info",
+                "reference": "GridDataChangedInfo"
+            }
+        ]
+    },
     "AdaptableScope": {
         "name": "AdaptableScope",
         "kind": "TypeAlias",
@@ -1965,10 +1996,17 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "JumpToCell",
                 "kind": "boolean",
-                "description": "Grid will 'jump' to the cell which triggered the Alert",
+                "description": "Grid will 'jump' to the changed cell which triggered the Alert",
                 "uiLabel": "Jump To Cell",
                 "isOptional": true
             },
+            {
+                "name": "JumpToRow",
+                "kind": "boolean",
+                "description": "Grid will 'jump' to the newly added row which triggered the Alert",
+                "uiLabel": "Jump To Row",
+                "isOptional": true
+            },
             {
                 "name": "LogToConsole",
                 "kind": "boolean",
@@ -2125,6 +2163,20 @@ exports.ADAPTABLE_METAMODEL = {
             }
         ]
     },
+    "BaseMenuContext": {
+        "name": "BaseMenuContext",
+        "kind": "Interface",
+        "description": "Base Context object used for both Column and Context Menu Context",
+        "properties": [
+            {
+                "name": "adaptableApi",
+                "kind": "REFERENCE",
+                "description": "The Adaptable Api - included as a convenience",
+                "uiLabel": "Adaptable Api",
+                "reference": "AdaptableApi"
+            }
+        ]
+    },
     "BulkUpdateApi": {
         "name": "BulkUpdateApi",
         "kind": "Interface",
@@ -2142,6 +2194,12 @@ exports.ADAPTABLE_METAMODEL = {
                 "description": "Returns current Bulk Update value",
                 "uiLabel": "Get Bulk Update Value"
             },
+            {
+                "name": "setBulkUpdateValue",
+                "kind": "function",
+                "description": "Sets Bulk Update value",
+                "uiLabel": "Set Bulk Update Value"
+            },
             {
                 "name": "showBulkUpdatePopup",
                 "kind": "function",
@@ -2415,7 +2473,7 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "timeout",
                 "kind": "number",
-                "description": "Time after which Cell should be unhilighted",
+                "description": "Time after which Cell should be unhighlighted",
                 "uiLabel": "Timeout",
                 "isOptional": true
             }
@@ -3391,10 +3449,10 @@ exports.ADAPTABLE_METAMODEL = {
                 "uiLabel": "Get User State By State Key"
             },
             {
-                "name": "incrementUerStateRevision",
+                "name": "incrementUserStateRevision",
                 "kind": "function",
                 "description": "Adds '1' to current revision number of State element",
-                "uiLabel": "Increment Uer State Revision"
+                "uiLabel": "Increment User State Revision"
             },
             {
                 "name": "loadUserState",
@@ -3423,7 +3481,7 @@ exports.ADAPTABLE_METAMODEL = {
         "properties": [
             {
                 "name": "Revision",
-                "kind": "number",
+                "kind": "unknown",
                 "description": "Version number of the Item - allows developers to update one section in Predefined Config while keeping others unchanged",
                 "uiLabel": "Revision",
                 "isOptional": true
@@ -4314,7 +4372,7 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "changedAt",
                 "kind": "number",
-                "description": "Timestamp of change occurence (in milliseconds)",
+                "description": "Timestamp of change occurrence (in milliseconds)",
                 "uiLabel": "Changed At"
             },
             {
@@ -4874,7 +4932,7 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "on",
                 "kind": "function",
-                "description": "Event fired when data changes in the Grid",
+                "description": "Event fired when a row is added, deleted or updated in the Grid",
                 "uiLabel": "On"
             },
             {
@@ -7106,6 +7164,12 @@ exports.ADAPTABLE_METAMODEL = {
                 "description": "Returns the Primary Kev Value for a given Row Node",
                 "uiLabel": "Get Primary Key Value For Row Node"
             },
+            {
+                "name": "getPrimaryKeyValuesForRowNodes",
+                "kind": "function",
+                "description": "Returns the Primary Kev Values for a given Row Node collection",
+                "uiLabel": "Get Primary Key Values For Row Nodes"
+            },
             {
                 "name": "getRawValueFromRowNode",
                 "kind": "function",
@@ -7178,6 +7242,12 @@ exports.ADAPTABLE_METAMODEL = {
                 "description": "Highlight a row using an adaptable style",
                 "uiLabel": "Highlight Row"
             },
+            {
+                "name": "highlightRows",
+                "kind": "function",
+                "description": "Highlight rows using an adaptable style",
+                "uiLabel": "Highlight Rows"
+            },
             {
                 "name": "isGridGroupable",
                 "kind": "function",
@@ -7253,15 +7323,21 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "refreshRowByPrimaryKey",
                 "kind": "function",
-                "description": "Forces a render of a row",
+                "description": "Forces a re-render of the row with the given primary key value",
                 "uiLabel": "Refresh Row By Primary Key"
             },
             {
                 "name": "refreshRowNode",
                 "kind": "function",
-                "description": "",
+                "description": "Forces a re-render of the given row",
                 "uiLabel": "Refresh Row Node"
             },
+            {
+                "name": "refreshRowNodes",
+                "kind": "function",
+                "description": "Forces a re-render of the given rows",
+                "uiLabel": "Refresh Row Nodes"
+            },
             {
                 "name": "selectAll",
                 "kind": "function",
@@ -7382,6 +7458,12 @@ exports.ADAPTABLE_METAMODEL = {
                 "description": "Remove highlight from row",
                 "uiLabel": "Un Highlight Row"
             },
+            {
+                "name": "unHighlightRows",
+                "kind": "function",
+                "description": "Remove highlight from row",
+                "uiLabel": "Un Highlight Rows"
+            },
             {
                 "name": "updateGridData",
                 "kind": "function",
@@ -7441,6 +7523,12 @@ exports.ADAPTABLE_METAMODEL = {
         "kind": "Interface",
         "description": "EventInfo returned by GridDataChanged event",
         "properties": [
+            {
+                "name": "changedAt",
+                "kind": "number",
+                "description": "Timestamp of change occurrence (in milliseconds)",
+                "uiLabel": "Changed At"
+            },
             {
                 "name": "dataRows",
                 "kind": "unknown",
@@ -7450,7 +7538,7 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "rowNodes",
                 "kind": "unknown",
-                "description": "AG Grid Row Nodes that were affected by the Change",
+                "description": "Row Nodes that were affected by this change",
                 "uiLabel": "Row Nodes"
             },
             {
@@ -7955,7 +8043,7 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "ExpandedRowGroupValues",
                 "kind": "unknown",
-                "description": "Values of opened row groups",
+                "description": "Opened Row Groups - set if `displayRowGroups` in LayoutOptions is 'dynamic'",
                 "uiLabel": "Expanded Row Group Values",
                 "isOptional": true
             },
@@ -8000,6 +8088,12 @@ exports.ADAPTABLE_METAMODEL = {
         "kind": "Interface",
         "description": "Provides run-time access to the Layout Module and associated state",
         "properties": [
+            {
+                "name": "areExpandedRowGroupsSavedInLayouts",
+                "kind": "function",
+                "description": "Returns true if Layouts will contain Expanded Row Groups information",
+                "uiLabel": "Are Expanded Row Groups Saved In Layouts"
+            },
             {
                 "name": "areLayoutsEqual",
                 "kind": "function",
@@ -8177,13 +8271,13 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "showLayoutEditor",
                 "kind": "function",
-                "description": "Opens the Layout Editor for the current Layout",
+                "description": "Opens Layout Editor - for Current or a named Layout",
                 "uiLabel": "Show Layout Editor"
             },
             {
                 "name": "showLayoutPopup",
                 "kind": "function",
-                "description": "Opens Settings Panel with Layout section selected and visible",
+                "description": "Opens Settings Panel with Layout section selected",
                 "uiLabel": "Show Layout Popup"
             }
         ]
@@ -8256,6 +8350,13 @@ exports.ADAPTABLE_METAMODEL = {
                 "gridInfo": "item",
                 "defaultValue": "false"
             },
+            {
+                "name": "displayRowGroups",
+                "kind": "unknown",
+                "description": "Whether RowGroups display all as expanded, all as closed or dynamically (i.e. saved in Layout)",
+                "uiLabel": "Display Row Groups",
+                "isOptional": true
+            },
             {
                 "name": "includeExpandedRowGroups",
                 "kind": "boolean",

package/src/types.d.ts

@@ -94,7 +94,7 @@ export type { SpecialColumnSettings } from './PredefinedConfig/Common/SpecialCol
 export type { CalculatedColumn, CalculatedColumnSettings, CalculatedColumnState, AdaptableCalculatedColumnQuery, } from './PredefinedConfig/CalculatedColumnState';
 export type { CellSummmary, CellSummaryOperation, CellSummaryOperationParams, } from './PredefinedConfig/Common/CellSummary';
 export type { FlashingCellDefinition, FlashingCellState, } from './PredefinedConfig/FlashingCellState';
-export type { AdaptableAlert } from './PredefinedConfig/Common/AdaptableAlert';
+export type { AdaptableAlert, AdaptableAlertType, AdaptableGenericAlert, AdaptableCellChangedAlert, AdaptableRowChangedAlert, AdaptableAlertBase, } from './PredefinedConfig/Common/AdaptableAlert';
 export type { AdaptableFlashingCell } from './PredefinedConfig/Common/AdaptableFlashingCell';
 export type { AdaptableColumn, AdaptableColumnBase, } from './PredefinedConfig/Common/AdaptableColumn';
 export type { AdaptableComparerFunction } from './PredefinedConfig/Common/AdaptableComparerFunction';
@@ -112,12 +112,13 @@ export type { AdaptableStyle } from './PredefinedConfig/Common/AdaptableStyle';
 export type { AdaptableIcon } from './PredefinedConfig/Common/AdaptableIcon';
 export type { CellHighlightInfo } from './PredefinedConfig/Common/CellHighlightInfo';
 export type { RowHighlightInfo } from './PredefinedConfig/Common/RowHighlightInfo';
+export type { RowsHighlightInfo } from './PredefinedConfig/Common/RowsHighlightInfo';
 export type { ColumnSort } from './PredefinedConfig/Common/ColumnSort';
 export type { DataChangedInfo } from './PredefinedConfig/Common/DataChangedInfo';
 export type { DataUpdateConfig } from './PredefinedConfig/Common/DataUpdateConfig';
 export type { AdaptableFormData, AdaptableForm, AdaptableFormField, } from './PredefinedConfig/Common/AdaptableForm';
 export type { AdaptableButton, ButtonContext } from './PredefinedConfig/Common/AdaptableButton';
-export type { AdaptableMenuItem, UserMenuItem, ColumnMenuContext, ContextMenuContext, } from './PredefinedConfig/Common/Menu';
+export type { AdaptableMenuItem, UserMenuItem, BaseMenuContext, ColumnMenuContext, ContextMenuContext, } from './PredefinedConfig/Common/Menu';
 export type { Schedule } from './PredefinedConfig/Common/Schedule';
 export type { ButtonStyle } from './PredefinedConfig/Common/ButtonStyle';
 export type { AdaptableModule, AdaptableToolPanel, AdaptableQLModule, } from './PredefinedConfig/Common/Types';

package/version.d.ts

@@ -1,2 +1,2 @@
-declare const _default: "11.0.9";
+declare const _default: "11.1.0";
 export default _default;

package/version.js

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