@adaptabletools/adaptable 11.2.4 → 12.0.0-canary.1

package/src/metamodel/adaptable.metamodel.js

@@ -118,6 +118,52 @@ exports.ADAPTABLE_METAMODEL = {
         "kind": "TypeAlias",
         "description": "Handles a Form Button Action"
     },
+    "ActionOptions": {
+        "name": "ActionOptions",
+        "kind": "Interface",
+        "description": "Options related to Action Columns and Buttons in Adaptable.",
+        "properties": [
+            {
+                "name": "actionColumns",
+                "kind": "unknown",
+                "description": "Columns which contain an AdapTable Button - used for performing Actions",
+                "uiLabel": "Action Columns",
+                "isOptional": true
+            },
+            {
+                "name": "actionRowButtons",
+                "kind": "unknown",
+                "description": "Action buttons to display for each row.",
+                "uiLabel": "Action Row Buttons",
+                "isOptional": true,
+                "defaultValue": "undefined"
+            },
+            {
+                "name": "actionRowButtonsPosition",
+                "kind": "unknown",
+                "description": "Position of supplied Action Buttons",
+                "uiLabel": "Action Row Buttons Position",
+                "isOptional": true,
+                "defaultValue": "'pinnedLeft'"
+            },
+            {
+                "name": "autoHandleActionRowButtons",
+                "kind": "boolean",
+                "description": "If set to true, the Action Row Buttons will be handled by AdapTable and the grid data model will be automatically updated with the created/edited/deleted rows",
+                "uiLabel": "Auto Handle Action Row Buttons",
+                "isOptional": true,
+                "defaultValue": "false"
+            },
+            {
+                "name": "setPrimaryKeyValue",
+                "kind": "unknown",
+                "description": "Function which is called when auto-handling the 'create' Action Row Button. The returned row value should have a valid(unique) primary key value.",
+                "uiLabel": "Set Primary Key Value",
+                "isOptional": true,
+                "defaultValue": "undefined"
+            }
+        ]
+    },
     "AdaptableAlert": {
         "name": "AdaptableAlert",
         "kind": "TypeAlias",
@@ -250,11 +296,11 @@ exports.ADAPTABLE_METAMODEL = {
                 "reference": "DataChangeHistoryApi"
             },
             {
-                "name": "dataSourceApi",
+                "name": "dataSetApi",
                 "kind": "REFERENCE",
-                "description": "Provides access to the Data Source Module",
-                "uiLabel": "Data Source Api",
-                "reference": "DataSourceApi"
+                "description": "Provides access to Data Sets",
+                "uiLabel": "Data Set Api",
+                "reference": "DataSetApi"
             },
             {
                 "name": "destroy",
@@ -317,6 +363,12 @@ exports.ADAPTABLE_METAMODEL = {
                 "description": "Cleanup method that only cleans up this api instance (clears event listeners and sets every property to null), but does not destroy the Adaptable instance.",
                 "uiLabel": "Internal Destroy Self"
             },
+            {
+                "name": "isDestroyed",
+                "kind": "unknown",
+                "description": "Whether the Adaptable instance has been destroyed",
+                "uiLabel": "Is Destroyed"
+            },
             {
                 "name": "layoutApi",
                 "kind": "REFERENCE",
@@ -453,7 +505,7 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "buttonStyle",
                 "kind": "unknown",
-                "description": "Style for Button - can be object or function thats provides a `Style` object",
+                "description": "Style for Button - can be object or function that provides a `ButtonStyle` object",
                 "uiLabel": "Button Style",
                 "isOptional": true
             },
@@ -473,11 +525,10 @@ exports.ADAPTABLE_METAMODEL = {
             },
             {
                 "name": "icon",
-                "kind": "REFERENCE",
-                "description": "Icon to display, requires string for URL, other props are optional",
+                "kind": "unknown",
+                "description": "Icon for Button - can be object or function that provides a `AdaptableIcon` object",
                 "uiLabel": "Icon",
-                "isOptional": true,
-                "reference": "AdaptableIcon"
+                "isOptional": true
             },
             {
                 "name": "label",
@@ -680,9 +731,10 @@ exports.ADAPTABLE_METAMODEL = {
             },
             {
                 "name": "dataType",
-                "kind": "unknown",
+                "kind": "REFERENCE",
                 "description": "DataType of the column",
-                "uiLabel": "Data Type"
+                "uiLabel": "Data Type",
+                "reference": "AdaptableColumnDataType"
             },
             {
                 "name": "friendlyName",
@@ -692,6 +744,11 @@ exports.ADAPTABLE_METAMODEL = {
             }
         ]
     },
+    "AdaptableColumnDataType": {
+        "name": "AdaptableColumnDataType",
+        "kind": "TypeAlias",
+        "description": "Type of data stored in an Adaptable Column"
+    },
     "AdaptableComparerFunction": {
         "name": "AdaptableComparerFunction",
         "kind": "TypeAlias",
@@ -848,14 +905,15 @@ exports.ADAPTABLE_METAMODEL = {
             },
             {
                 "name": "fieldType",
-                "kind": "unknown",
+                "kind": "REFERENCE",
                 "description": "Field Type: text, date, number, checkbox, select, textOutput",
-                "uiLabel": "Field Type"
+                "uiLabel": "Field Type",
+                "reference": "unknown"
             },
             {
                 "name": "label",
                 "kind": "string",
-                "description": "Label to display in in the Field",
+                "description": "Label to display in the Field",
                 "uiLabel": "Label"
             },
             {
@@ -1009,7 +1067,7 @@ exports.ADAPTABLE_METAMODEL = {
     "AdaptableObjectTag": {
         "name": "AdaptableObjectTag",
         "kind": "TypeAlias",
-        "description": "Object Tag - defined as a label and a value"
+        "description": "AdaptableObjectTag Object Tague - currently supporting only plain string values, but open for future extensions, if ever needed."
     },
     "AdaptableOptions": {
         "name": "AdaptableOptions",
@@ -1060,6 +1118,14 @@ exports.ADAPTABLE_METAMODEL = {
                 "gridInfo": "item",
                 "defaultValue": "false"
             },
+            {
+                "name": "columnOptions",
+                "kind": "REFERENCE",
+                "description": "Options for managing Columns",
+                "uiLabel": "Column Options",
+                "isOptional": true,
+                "reference": "ColumnOptions"
+            },
             {
                 "name": "containerOptions",
                 "kind": "REFERENCE",
@@ -1068,13 +1134,6 @@ exports.ADAPTABLE_METAMODEL = {
                 "isOptional": true,
                 "reference": "ContainerOptions"
             },
-            {
-                "name": "customPredicateDefs",
-                "kind": "unknown",
-                "description": "Predicate definitions provided by developers at Design-Time",
-                "uiLabel": "Custom Predicate Defs",
-                "isOptional": true
-            },
             {
                 "name": "dashboardOptions",
                 "kind": "REFERENCE",
@@ -1138,15 +1197,6 @@ exports.ADAPTABLE_METAMODEL = {
                 "gridInfo": "container",
                 "reference": "FlashingCellOptions"
             },
-            {
-                "name": "formatColumnOptions",
-                "kind": "REFERENCE",
-                "description": "Options for managing format columns",
-                "uiLabel": "Format Column Options",
-                "isOptional": true,
-                "gridInfo": "container",
-                "reference": "unknown"
-            },
             {
                 "name": "generalOptions",
                 "kind": "REFERENCE",
@@ -1410,6 +1460,13 @@ exports.ADAPTABLE_METAMODEL = {
                 "gridInfo": "item",
                 "defaultValue": "false"
             },
+            {
+                "name": "customPredicateDefs",
+                "kind": "unknown",
+                "description": "Definitions for Custom provided Predicates",
+                "uiLabel": "Custom Predicate Defs",
+                "isOptional": true
+            },
             {
                 "name": "expressionOptions",
                 "kind": "REFERENCE",
@@ -1486,10 +1543,10 @@ exports.ADAPTABLE_METAMODEL = {
                 "uiLabel": "Current Query"
             },
             {
-                "name": "dataSource",
+                "name": "dataSet",
                 "kind": "unknown",
-                "description": "Current Data Source (if one selected)",
-                "uiLabel": "Data Source"
+                "description": "Current DataSet (if one selected)",
+                "uiLabel": "Data Set"
             },
             {
                 "name": "queryAST",
@@ -1997,6 +2054,28 @@ exports.ADAPTABLE_METAMODEL = {
         "kind": "TypeAlias",
         "description": "Form to show in an Alert"
     },
+    "AlertMessageContext": {
+        "name": "AlertMessageContext",
+        "kind": "Interface",
+        "description": "Context used for creating bespoke Alert messages",
+        "properties": [
+            {
+                "name": "alertDefinition",
+                "kind": "REFERENCE",
+                "description": "Current Alert Definition",
+                "uiLabel": "Alert Definition",
+                "reference": "AlertDefinition"
+            },
+            {
+                "name": "cellDataChangedInfo",
+                "kind": "REFERENCE",
+                "description": "Data change that might have triggered the Alert",
+                "uiLabel": "Cell Data Changed Info",
+                "isOptional": true,
+                "reference": "CellDataChangedInfo"
+            }
+        ]
+    },
     "AlertOptions": {
         "name": "AlertOptions",
         "kind": "Interface",
@@ -2287,7 +2366,7 @@ exports.ADAPTABLE_METAMODEL = {
     "BaseContext": {
         "name": "BaseContext",
         "kind": "Interface",
-        "description": "Base Context object used in many functions provided by AdapTable",
+        "description": "Base Context used in many functions provided by developers and invoked as needed by AdapTable",
         "properties": [
             {
                 "name": "adaptableApi",
@@ -2497,6 +2576,14 @@ exports.ADAPTABLE_METAMODEL = {
                 "uiLabel": "Data Type",
                 "isOptional": true
             },
+            {
+                "name": "ExternallyEvaluatedExpression",
+                "kind": "boolean",
+                "description": "If true, the Calculated Column Expression will NOT be evaluated and the value is loaded from the row data property with the same name as the ColumnId",
+                "uiLabel": "Externally Evaluated Expression",
+                "isOptional": true,
+                "defaultValue": "false"
+            },
             {
                 "name": "ShowToolTip",
                 "kind": "boolean",
@@ -3058,6 +3145,12 @@ exports.ADAPTABLE_METAMODEL = {
                 "description": "Is Column an Action Column",
                 "uiLabel": "Is Action Column"
             },
+            {
+                "name": "isActionRowButtonColumn",
+                "kind": "function",
+                "description": "Checks if a column is a ActionRowButton column (see UserInterfaceOptions.ActionOptions)",
+                "uiLabel": "Is Action Row Button Column"
+            },
             {
                 "name": "isAutoPivotColumn",
                 "kind": "function",
@@ -3195,6 +3288,26 @@ exports.ADAPTABLE_METAMODEL = {
             }
         ]
     },
+    "ColumnFriendlyNameContext": {
+        "name": "ColumnFriendlyNameContext",
+        "kind": "Interface",
+        "description": "Context used when setting a Column Friendly Name",
+        "properties": [
+            {
+                "name": "agColumn",
+                "kind": "REFERENCE",
+                "description": "AG Grid ColDef for the Column",
+                "uiLabel": "Ag Column",
+                "reference": "unknown"
+            },
+            {
+                "name": "colId",
+                "kind": "string",
+                "description": "Id of the Column",
+                "uiLabel": "Col Id"
+            }
+        ]
+    },
     "ColumnMenuContext": {
         "name": "ColumnMenuContext",
         "kind": "Interface",
@@ -3222,6 +3335,54 @@ exports.ADAPTABLE_METAMODEL = {
             }
         ]
     },
+    "ColumnOptions": {
+        "name": "ColumnOptions",
+        "kind": "Interface",
+        "description": "Options related to managing Columns in Adaptable.",
+        "properties": [
+            {
+                "name": "autoOrderGroupedColumns",
+                "kind": "boolean",
+                "description": "Order Grouped Column automatically, deriving from Adaptable State if available (CustomSort or Layout ColumnSort)",
+                "uiLabel": "Auto Order Grouped Columns",
+                "isOptional": true,
+                "gridInfo": "item",
+                "defaultValue": "true"
+            },
+            {
+                "name": "columnFriendlyName",
+                "kind": "unknown",
+                "description": "Provide an alternative Friendly Name for a Column",
+                "uiLabel": "Column Friendly Name",
+                "isOptional": true
+            },
+            {
+                "name": "columnTypes",
+                "kind": "unknown",
+                "description": "Optional list of Column Types - used primarily for Special Columns",
+                "uiLabel": "Column Types",
+                "isOptional": true
+            },
+            {
+                "name": "hideColumnWhenGrouped",
+                "kind": "boolean",
+                "description": "Automatically removes a column from the grid when it becomes Row Grouped",
+                "uiLabel": "Hide Column When Grouped",
+                "isOptional": true,
+                "gridInfo": "item",
+                "defaultValue": "false"
+            },
+            {
+                "name": "showMissingColumnsWarning",
+                "kind": "boolean",
+                "description": "Show warning if AdapTable cannot find a column",
+                "uiLabel": "Show Missing Columns Warning",
+                "isOptional": true,
+                "gridInfo": "item",
+                "defaultValue": "true"
+            }
+        ]
+    },
     "ColumnSort": {
         "name": "ColumnSort",
         "kind": "Interface",
@@ -3339,6 +3500,18 @@ exports.ADAPTABLE_METAMODEL = {
                 "description": "Adds new Conditional Style to State",
                 "uiLabel": "Add Conditional Style"
             },
+            {
+                "name": "deleteConditionalStyle",
+                "kind": "function",
+                "description": "Deletes a Conditional Style",
+                "uiLabel": "Delete Conditional Style"
+            },
+            {
+                "name": "deleteConditionalStyles",
+                "kind": "function",
+                "description": "Deletes Conditional Styles",
+                "uiLabel": "Delete Conditional Styles"
+            },
             {
                 "name": "editConditionalStyle",
                 "kind": "function",
@@ -3545,12 +3718,6 @@ exports.ADAPTABLE_METAMODEL = {
                 "description": "Returns Dashboard section of Adaptable State",
                 "uiLabel": "Get Dashboard State"
             },
-            {
-                "name": "getDataSourceState",
-                "kind": "function",
-                "description": "Returns Data Source section of Adaptable State",
-                "uiLabel": "Get Data Source State"
-            },
             {
                 "name": "getDescriptionForModule",
                 "kind": "function",
@@ -3563,12 +3730,6 @@ exports.ADAPTABLE_METAMODEL = {
                 "description": "Returns Export section of Adaptable State",
                 "uiLabel": "Get Export State"
             },
-            {
-                "name": "getFilterState",
-                "kind": "function",
-                "description": "Returns Filter section of Adaptable State",
-                "uiLabel": "Get Filter State"
-            },
             {
                 "name": "getFormatColumnState",
                 "kind": "function",
@@ -4373,18 +4534,6 @@ exports.ADAPTABLE_METAMODEL = {
         "kind": "Interface",
         "description": "Functions relating to the AdapTable Dashboard.",
         "properties": [
-            {
-                "name": "addCustomToolbarButtons",
-                "kind": "function",
-                "description": "Adds Toolbar Buttons to current collection in Custom Toolbar",
-                "uiLabel": "Add Custom Toolbar Buttons"
-            },
-            {
-                "name": "clearCustomToolbarButtons",
-                "kind": "function",
-                "description": "Clears all Toolbar Buttons from Custom Toolbar",
-                "uiLabel": "Clear Custom Toolbar Buttons"
-            },
             {
                 "name": "collapseDashboard",
                 "kind": "function",
@@ -4529,6 +4678,12 @@ exports.ADAPTABLE_METAMODEL = {
                 "description": "Checks if a given Toolbar is visible",
                 "uiLabel": "Is Toolbar Visible"
             },
+            {
+                "name": "refreshDashboard",
+                "kind": "function",
+                "description": "Refreshes the entire Dashboard section, including Toolbars and Buttons; this is particularly relevant for AdapTable built-in elements, as framework components are dependent on the framework specific change detection mechanisms",
+                "uiLabel": "Refresh Dashboard"
+            },
             {
                 "name": "setActiveTab",
                 "kind": "function",
@@ -4541,12 +4696,6 @@ exports.ADAPTABLE_METAMODEL = {
                 "description": "Sets Active Tab in Dashboard",
                 "uiLabel": "Set Active Tab Index"
             },
-            {
-                "name": "setCustomToolbarButtons",
-                "kind": "function",
-                "description": "Replaces Toolbar Buttons in Custom Toolbar with the new set",
-                "uiLabel": "Set Custom Toolbar Buttons"
-            },
             {
                 "name": "setCustomToolbarContents",
                 "kind": "function",
@@ -4819,6 +4968,13 @@ exports.ADAPTABLE_METAMODEL = {
         "kind": "Interface",
         "description": "Options to manage the 'Data Change History Module', which provides an overview of all previous changes, giving the possibility to undo specific changes",
         "properties": [
+            {
+                "name": "actionColumnButton",
+                "kind": "unknown",
+                "description": "Action button definition. Can be used to implement undo functionality.",
+                "uiLabel": "Action Column Button",
+                "isOptional": true
+            },
             {
                 "name": "activeByDefault",
                 "kind": "boolean",
@@ -4839,117 +4995,78 @@ exports.ADAPTABLE_METAMODEL = {
             }
         ]
     },
-    "DataSource": {
-        "name": "DataSource",
+    "DataSet": {
+        "name": "DataSet",
         "kind": "Interface",
-        "description": "Defines a Data Source object - used in Data Source function",
+        "description": "Defines a Data Set object that can provide data to AdapTable",
         "properties": [
             {
-                "name": "Description",
+                "name": "description",
                 "kind": "string",
-                "description": "Describes the Data Source",
+                "description": "Describes the Data Set",
                 "uiLabel": "Description"
             },
             {
-                "name": "Form",
+                "name": "form",
                 "kind": "unknown",
-                "description": "Params for DataSource pops up a form",
+                "description": "Params for Data Set popup form",
                 "uiLabel": "Form",
                 "isOptional": true
             },
             {
-                "name": "Name",
+                "name": "name",
                 "kind": "string",
-                "description": "Name of Data Source",
+                "description": "Name of Data Set",
                 "uiLabel": "Name"
             }
         ]
     },
-    "DataSourceApi": {
-        "name": "DataSourceApi",
+    "DataSetApi": {
+        "name": "DataSetApi",
         "kind": "Interface",
-        "description": "Provides run-time access to Data Source Module",
+        "description": "Provides run-time access to Data Sets",
         "properties": [
             {
-                "name": "addDataSource",
-                "kind": "function",
-                "description": "Adds new DataSource to State",
-                "uiLabel": "Add Data Source"
-            },
-            {
-                "name": "clearDataSource",
+                "name": "clearCurrentDataSet",
                 "kind": "function",
-                "description": "Clears currently selected DataSource",
-                "uiLabel": "Clear Data Source"
+                "description": "Clears currently selected Data Set",
+                "uiLabel": "Clear Current Data Set"
             },
             {
-                "name": "createDataSource",
+                "name": "fireDataSetChangeEvent",
                 "kind": "function",
-                "description": "Creates a DataSource from a given name and description",
-                "uiLabel": "Create Data Source"
+                "description": "Fire the DataSet Changed Event",
+                "uiLabel": "Fire Data Set Change Event"
             },
             {
-                "name": "getAllDataSource",
+                "name": "getAllDataSets",
                 "kind": "function",
-                "description": "Retrieves all Data Sources in the Adaptable State",
-                "uiLabel": "Get All Data Source"
+                "description": "Retrieves the Data Sets from General Options",
+                "uiLabel": "Get All Data Sets"
             },
             {
-                "name": "getCurrentDataSource",
+                "name": "getCurrentDataSet",
                 "kind": "function",
-                "description": "Retrieves the currently applied Data Source",
-                "uiLabel": "Get Current Data Source"
+                "description": "Retrieves the currently applied Data Set",
+                "uiLabel": "Get Current Data Set"
             },
             {
-                "name": "getDataSourceById",
+                "name": "getDataSetByName",
                 "kind": "function",
-                "description": "Retrieves Data Source by id",
-                "uiLabel": "Get Data Source By Id"
+                "description": "Retreives Data Set from State with given name",
+                "uiLabel": "Get Data Set By Name"
             },
             {
-                "name": "getDataSourceByName",
+                "name": "setDataSet",
                 "kind": "function",
-                "description": "Retrives Data Source from State with given name",
-                "uiLabel": "Get Data Source By Name"
+                "description": "Makes given Data Set current",
+                "uiLabel": "Set Data Set"
             },
             {
-                "name": "getDataSourceState",
+                "name": "showDataSetPopup",
                 "kind": "function",
-                "description": "Retrieves Data Source section from Adaptable State",
-                "uiLabel": "Get Data Source State"
-            },
-            {
-                "name": "setDataSource",
-                "kind": "function",
-                "description": "Makes given DataSource current",
-                "uiLabel": "Set Data Source"
-            },
-            {
-                "name": "showDataSourcePopup",
-                "kind": "function",
-                "description": "Opens Settings Panel with Data Source section selected and visible",
-                "uiLabel": "Show Data Source Popup"
-            }
-        ]
-    },
-    "DataSourceState": {
-        "name": "DataSourceState",
-        "kind": "Interface",
-        "description": "Predefined Configuration for Data Source Module",
-        "properties": [
-            {
-                "name": "CurrentDataSource",
-                "kind": "string",
-                "description": "Name of the currently selected Data Source",
-                "uiLabel": "Current Data Source",
-                "isOptional": true
-            },
-            {
-                "name": "DataSources",
-                "kind": "unknown",
-                "description": "Collection of available Data Sources",
-                "uiLabel": "Data Sources",
-                "isOptional": true
+                "description": "Opens Settings Panel with Data Set section selected and visible",
+                "uiLabel": "Show Data Set Popup"
             }
         ]
     },
@@ -5076,6 +5193,21 @@ exports.ADAPTABLE_METAMODEL = {
                 "uiLabel": "Is Cell Editable",
                 "isOptional": true
             },
+            {
+                "name": "rowFormOptions",
+                "kind": "REFERENCE",
+                "description": "Options for editing (create/update/delete) row entries in the grid.",
+                "uiLabel": "Row Form Options",
+                "isOptional": true,
+                "reference": "RowFormOptions"
+            },
+            {
+                "name": "smartEditCustomOperations",
+                "kind": "unknown",
+                "description": "Custom Operations to use in Smart Edit",
+                "uiLabel": "Smart Edit Custom Operations",
+                "isOptional": true
+            },
             {
                 "name": "validateOnServer",
                 "kind": "unknown",
@@ -5156,6 +5288,18 @@ exports.ADAPTABLE_METAMODEL = {
                 "description": "Unsubscribe from LiveDataChanged",
                 "uiLabel": "Off"
             },
+            {
+                "name": "off",
+                "kind": "function",
+                "description": "Unsubscribe from RowFormSubmitted",
+                "uiLabel": "Off"
+            },
+            {
+                "name": "off",
+                "kind": "function",
+                "description": "Unsubscribe from DataSetChanged",
+                "uiLabel": "Off"
+            },
             {
                 "name": "off",
                 "kind": "function",
@@ -5252,6 +5396,18 @@ exports.ADAPTABLE_METAMODEL = {
                 "description": "Event fired whenever **a change occurs relating to live reports / data** Used in conjunction with AdapTable's partners OpenFin, ipushpull or Glue42",
                 "uiLabel": "On"
             },
+            {
+                "name": "on",
+                "kind": "function",
+                "description": "Event fired when a Row Form is submitted",
+                "uiLabel": "On"
+            },
+            {
+                "name": "on",
+                "kind": "function",
+                "description": "Event fired when a DataSet is changed",
+                "uiLabel": "On"
+            },
             {
                 "name": "on",
                 "kind": "function",
@@ -5477,8 +5633,8 @@ exports.ADAPTABLE_METAMODEL = {
             }
         ]
     },
-    "ExportButtonContext": {
-        "name": "ExportButtonContext",
+    "ExportFormContext": {
+        "name": "ExportFormContext",
         "kind": "Interface",
         "description": "Context required by functions when using an Export Button",
         "properties": [
@@ -5489,13 +5645,6 @@ exports.ADAPTABLE_METAMODEL = {
                 "uiLabel": "Custom Destination",
                 "reference": "CustomDestination"
             },
-            {
-                "name": "formData",
-                "kind": "REFERENCE",
-                "description": "Adaptable Form Data",
-                "uiLabel": "Form Data",
-                "reference": "unknown"
-            },
             {
                 "name": "report",
                 "kind": "REFERENCE",
@@ -5928,12 +6077,6 @@ exports.ADAPTABLE_METAMODEL = {
         "kind": "Interface",
         "description": "Provides run-time access to Filter section of Adaptable State.",
         "properties": [
-            {
-                "name": "clearAllColumnFilter",
-                "kind": "function",
-                "description": "Clears all Column Filters in State",
-                "uiLabel": "Clear All Column Filter"
-            },
             {
                 "name": "clearAndSetColumnFilter",
                 "kind": "function",
@@ -5958,6 +6101,12 @@ exports.ADAPTABLE_METAMODEL = {
                 "description": "Clears Column Filters for given set of Columns",
                 "uiLabel": "Clear Column Filter By Columns"
             },
+            {
+                "name": "clearColumnFilters",
+                "kind": "function",
+                "description": "Clears all Column Filters in the Current Layout",
+                "uiLabel": "Clear Column Filters"
+            },
             {
                 "name": "columnFiltersToString",
                 "kind": "function",
@@ -5971,10 +6120,16 @@ exports.ADAPTABLE_METAMODEL = {
                 "uiLabel": "Column Filter To String"
             },
             {
-                "name": "createColumnFilterForCell",
+                "name": "createEqualityColumnFilterForCell",
                 "kind": "function",
-                "description": "Creates new Column Filter on given Column using Primary Key values",
-                "uiLabel": "Create Column Filter For Cell"
+                "description": "Creates an Equality Filter based on given Grid Cell",
+                "uiLabel": "Create Equality Column Filter For Cell"
+            },
+            {
+                "name": "createValuesColumnFilterForCells",
+                "kind": "function",
+                "description": "Creates an Equality Filter based on given Grid Cells",
+                "uiLabel": "Create Values Column Filter For Cells"
             },
             {
                 "name": "evaluateColumnFilter",
@@ -5988,12 +6143,6 @@ exports.ADAPTABLE_METAMODEL = {
                 "description": "Returns Predicate Definition for given Column and Quick Filter shortcut",
                 "uiLabel": "Find Predicate Def By Shortcut"
             },
-            {
-                "name": "getAllColumnFilter",
-                "kind": "function",
-                "description": "Retrieves all the Column Filters in the Column Filter State (of Predefined Config)",
-                "uiLabel": "Get All Column Filter"
-            },
             {
                 "name": "getAllColumnFilterForColumn",
                 "kind": "function",
@@ -6007,10 +6156,10 @@ exports.ADAPTABLE_METAMODEL = {
                 "uiLabel": "Get All System Filter Ids"
             },
             {
-                "name": "getColumnFilterById",
+                "name": "getColumnFilters",
                 "kind": "function",
-                "description": "Retrieves ColumnFilter by Id",
-                "uiLabel": "Get Column Filter By Id"
+                "description": "Retrieves all the Column Filters in the Column Filter State (of Predefined Config)",
+                "uiLabel": "Get Column Filters"
             },
             {
                 "name": "getFilterPredicateDefsForColumn",
@@ -6024,12 +6173,6 @@ exports.ADAPTABLE_METAMODEL = {
                 "description": "Gets all Filter Predicates available for a given ColumnId",
                 "uiLabel": "Get Filter Predicate Defs For Column Id"
             },
-            {
-                "name": "getFilterState",
-                "kind": "function",
-                "description": "Retrieves Filter section from Adaptable State",
-                "uiLabel": "Get Filter State"
-            },
             {
                 "name": "hideQuickFilterBar",
                 "kind": "function",
@@ -6209,6 +6352,14 @@ exports.ADAPTABLE_METAMODEL = {
                 "gridInfo": "item",
                 "defaultValue": "'mouseenter'"
             },
+            {
+                "name": "showQuickFilter",
+                "kind": "boolean",
+                "description": "Whether to display Quick Filter Bar between Column Header and the Grid (provided its been setup)",
+                "uiLabel": "Show Quick Filter",
+                "isOptional": true,
+                "defaultValue": "true"
+            },
             {
                 "name": "sortColumnValuesInFilter",
                 "kind": "boolean",
@@ -6269,28 +6420,6 @@ exports.ADAPTABLE_METAMODEL = {
             }
         ]
     },
-    "FilterState": {
-        "name": "FilterState",
-        "kind": "Interface",
-        "description": "Predefined Configuration for Filters",
-        "properties": [
-            {
-                "name": "ColumnFilters",
-                "kind": "unknown",
-                "description": "Collection of Column Filters",
-                "uiLabel": "Column Filters",
-                "isOptional": true
-            },
-            {
-                "name": "IsQuickFilterVisible",
-                "kind": "boolean",
-                "description": "Whether to display Quick Filter Bar between Column Header and the Grid",
-                "uiLabel": "Is Quick Filter Visible",
-                "isOptional": true,
-                "defaultValue": "true"
-            }
-        ]
-    },
     "FinanceApi": {
         "name": "FinanceApi",
         "kind": "Interface",
@@ -6779,6 +6908,12 @@ exports.ADAPTABLE_METAMODEL = {
                 "description": "Publishes the CheckboxColumnClickedEvent - when the checkbox in an Checkbox Column is clicked",
                 "uiLabel": "Fire Checkbox Column Clicked Event"
             },
+            {
+                "name": "getActiveFormatColumnForColumn",
+                "kind": "function",
+                "description": "Gets an active Format Column, if any, for given Column",
+                "uiLabel": "Get Active Format Column For Column"
+            },
             {
                 "name": "getAllActiveFormatColumn",
                 "kind": "function",
@@ -7144,15 +7279,6 @@ exports.ADAPTABLE_METAMODEL = {
                 "isOptional": true,
                 "defaultValue": "null"
             },
-            {
-                "name": "autoOrderGroupedColumns",
-                "kind": "boolean",
-                "description": "Order Grouped Column automatically, deriving from Adaptable State if available (CustomSort or Layout ColumnSort)",
-                "uiLabel": "Auto Order Grouped Columns",
-                "isOptional": true,
-                "gridInfo": "item",
-                "defaultValue": "true"
-            },
             {
                 "name": "cellSummaryOperations",
                 "kind": "unknown",
@@ -7176,6 +7302,13 @@ exports.ADAPTABLE_METAMODEL = {
                 "uiLabel": "Custom Sort Comparers",
                 "isOptional": true
             },
+            {
+                "name": "dataSets",
+                "kind": "unknown",
+                "description": "Collection of Data Sets to provide Data to AdapTable",
+                "uiLabel": "Data Sets",
+                "isOptional": true
+            },
             {
                 "name": "englishVariant",
                 "kind": "unknown",
@@ -7185,15 +7318,6 @@ exports.ADAPTABLE_METAMODEL = {
                 "gridInfo": "item",
                 "defaultValue": "'GB'"
             },
-            {
-                "name": "hideColumnWhenGrouped",
-                "kind": "boolean",
-                "description": "Automatically removes a column from the grid when it becomes Row Grouped",
-                "uiLabel": "Hide Column When Grouped",
-                "isOptional": true,
-                "gridInfo": "item",
-                "defaultValue": "false"
-            },
             {
                 "name": "hideEmptyGroupRows",
                 "kind": "boolean",
@@ -7211,15 +7335,6 @@ exports.ADAPTABLE_METAMODEL = {
                 "gridInfo": "item",
                 "defaultValue": "false"
             },
-            {
-                "name": "showMissingColumnsWarning",
-                "kind": "boolean",
-                "description": "Show warning if AdapTable cannot find a column",
-                "uiLabel": "Show Missing Columns Warning",
-                "isOptional": true,
-                "gridInfo": "item",
-                "defaultValue": "true"
-            },
             {
                 "name": "showMissingPrimaryKeyAlert",
                 "kind": "boolean",
@@ -7874,6 +7989,24 @@ exports.ADAPTABLE_METAMODEL = {
                 "description": "Loads grid with given data",
                 "uiLabel": "Load Grid Data"
             },
+            {
+                "name": "openCloneRowForm",
+                "kind": "function",
+                "description": "Open create dialog for cloning an existing row",
+                "uiLabel": "Open Clone Row Form"
+            },
+            {
+                "name": "openCreateRowForm",
+                "kind": "function",
+                "description": "Open create dialog for a new row",
+                "uiLabel": "Open Create Row Form"
+            },
+            {
+                "name": "openEditRowForm",
+                "kind": "function",
+                "description": "Open edit dialog for row with the given primary key value",
+                "uiLabel": "Open Edit Row Form"
+            },
             {
                 "name": "redrawGrid",
                 "kind": "function",
@@ -8620,6 +8753,13 @@ exports.ADAPTABLE_METAMODEL = {
                 "uiLabel": "Auto Save",
                 "isOptional": true
             },
+            {
+                "name": "ColumnFilters",
+                "kind": "unknown",
+                "description": "Collection of Column Filters.",
+                "uiLabel": "Column Filters",
+                "isOptional": true
+            },
             {
                 "name": "ColumnHeadersMap",
                 "kind": "unknown",
@@ -8858,6 +8998,24 @@ exports.ADAPTABLE_METAMODEL = {
                 "description": "Does an object's Tags include the Current Layout",
                 "uiLabel": "Is Object Available In Current Layout"
             },
+            {
+                "name": "removeColumnFromAllLayouts",
+                "kind": "function",
+                "description": "Removes a Column from all Layouts",
+                "uiLabel": "Remove Column From All Layouts"
+            },
+            {
+                "name": "removeColumnFromCurrentLayout",
+                "kind": "function",
+                "description": "Removes a Column from the Current Layout",
+                "uiLabel": "Remove Column From Current Layout"
+            },
+            {
+                "name": "removeColumnFromLayout",
+                "kind": "function",
+                "description": "Removes a Column from a given Layout",
+                "uiLabel": "Remove Column From Layout"
+            },
             {
                 "name": "saveCurrentLayout",
                 "kind": "function",
@@ -9132,6 +9290,27 @@ exports.ADAPTABLE_METAMODEL = {
             }
         ]
     },
+    "MasterDetailPluginOptions": {
+        "name": "MasterDetailPluginOptions",
+        "kind": "Interface",
+        "description": "Plugin Options used when creating a Master / Detail grid - passed into the plugin as the only argument.",
+        "properties": [
+            {
+                "name": "detailAdaptableOptions",
+                "kind": "REFERENCE",
+                "description": "`AdaptableOptions` object to use for child Data Grids; **all** will share the same behaviour and State",
+                "uiLabel": "Detail Adaptable Options",
+                "reference": "AdaptableOptions"
+            },
+            {
+                "name": "onDetailInit",
+                "kind": "unknown",
+                "description": "Function called when Detail Grid is initialised (i.e. opens) receives an Adaptable Api object",
+                "uiLabel": "On Detail Init",
+                "isOptional": true
+            }
+        ]
+    },
     "MenuOptions": {
         "name": "MenuOptions",
         "kind": "Interface",
@@ -10050,14 +10229,6 @@ exports.ADAPTABLE_METAMODEL = {
                 "isOptional": true,
                 "reference": "DashboardState"
             },
-            {
-                "name": "DataSource",
-                "kind": "REFERENCE",
-                "description": "Supplies a collection of *DataSource* objects to facilitate replacing the DataSource in the Grid with an alternate set of data (e.g. a Book or Stored Proc name)",
-                "uiLabel": "Data Source",
-                "isOptional": true,
-                "reference": "DataSourceState"
-            },
             {
                 "name": "Export",
                 "kind": "REFERENCE",
@@ -10066,14 +10237,6 @@ exports.ADAPTABLE_METAMODEL = {
                 "isOptional": true,
                 "reference": "ExportState"
             },
-            {
-                "name": "Filter",
-                "kind": "REFERENCE",
-                "description": "Stores Filters in AdapTable - both System and Column (predicate) Filters",
-                "uiLabel": "Filter",
-                "isOptional": true,
-                "reference": "FilterState"
-            },
             {
                 "name": "FlashingCell",
                 "kind": "REFERENCE",
@@ -10152,7 +10315,7 @@ exports.ADAPTABLE_METAMODEL = {
                 "description": "Configures the Adaptable Status Bar",
                 "uiLabel": "Status Bar",
                 "isOptional": true,
-                "reference": "unknown"
+                "reference": "StatusBarState"
             },
             {
                 "name": "Theme",
@@ -10189,6 +10352,12 @@ exports.ADAPTABLE_METAMODEL = {
                 "description": "Returns Predicate Definitions provided by users",
                 "uiLabel": "Get Custom Predicate Defs"
             },
+            {
+                "name": "getEqualityPredicateForDataType",
+                "kind": "function",
+                "description": "Gets the correct Equality-type System Predicate for a particular DataType",
+                "uiLabel": "Get Equality Predicate For Data Type"
+            },
             {
                 "name": "getPredicateDefById",
                 "kind": "function",
@@ -10619,6 +10788,52 @@ exports.ADAPTABLE_METAMODEL = {
             }
         ]
     },
+    "RowFormOptions": {
+        "name": "RowFormOptions",
+        "kind": "Interface",
+        "description": "Options for editing (create/update/delete) row entries in the grid",
+        "properties": [
+            {
+                "name": "formButtons",
+                "kind": "unknown",
+                "description": "Custom form buttons provider. If provided, the custom implementation is responsible for firing the 'RowFormSubmitted' and/or invoking the 'onFormSubmit' callback (if necessary).",
+                "uiLabel": "Form Buttons",
+                "isOptional": true
+            },
+            {
+                "name": "formDescription",
+                "kind": "unknown",
+                "description": "Custom form description provider",
+                "uiLabel": "Form Description",
+                "isOptional": true,
+                "defaultValue": "undefined"
+            },
+            {
+                "name": "formFieldLabel",
+                "kind": "unknown",
+                "description": "Custom form field label provider",
+                "uiLabel": "Form Field Label",
+                "isOptional": true,
+                "defaultValue": "undefined"
+            },
+            {
+                "name": "formTitle",
+                "kind": "unknown",
+                "description": "Custom form title provider",
+                "uiLabel": "Form Title",
+                "isOptional": true,
+                "defaultValue": "'Create New Row'/'Edit Row'"
+            },
+            {
+                "name": "onFormSubmit",
+                "kind": "unknown",
+                "description": "Function which is invoked when a row form is submitted via a standard button (provided by AdapTable). This is not invoked when custom form buttons are provided!",
+                "uiLabel": "On Form Submit",
+                "isOptional": true,
+                "defaultValue": "undefined"
+            }
+        ]
+    },
     "RowInfo": {
         "name": "RowInfo",
         "kind": "Interface",
@@ -11511,6 +11726,12 @@ exports.ADAPTABLE_METAMODEL = {
                 "description": "Applies a Smart Edit to given Cells",
                 "uiLabel": "Apply Smart Edit"
             },
+            {
+                "name": "getSmartEditCustomOperations",
+                "kind": "function",
+                "description": "Retrieves an Smart Edit Custom Operations (provided in Edit Options)",
+                "uiLabel": "Get Smart Edit Custom Operations"
+            },
             {
                 "name": "getSmartEditOperation",
                 "kind": "function",
@@ -11523,10 +11744,16 @@ exports.ADAPTABLE_METAMODEL = {
                 "description": "Returns current Smart Edit Value",
                 "uiLabel": "Get Smart Edit Value"
             },
+            {
+                "name": "setCustomSmartEditOperation",
+                "kind": "function",
+                "description": "Sets current Smart Edit Operation to a Custom Operation",
+                "uiLabel": "Set Custom Smart Edit Operation"
+            },
             {
                 "name": "setSmartEditOperation",
                 "kind": "function",
-                "description": "Sets Smart Edit operation: ('Add','Subtract','Multiply','Divide'",
+                "description": "Sets (shipped) Smart Edit Operation: 'Add','Subtract','Multiply','Divide'",
                 "uiLabel": "Set Smart Edit Operation"
             },
             {
@@ -11543,6 +11770,31 @@ exports.ADAPTABLE_METAMODEL = {
             }
         ]
     },
+    "SmartEditCustomOperation": {
+        "name": "SmartEditCustomOperation",
+        "kind": "TypeAlias",
+        "description": "Custom Operation used in Smart Edit Module"
+    },
+    "SmartEditOperationContext": {
+        "name": "SmartEditOperationContext",
+        "kind": "Interface",
+        "description": "Context used in Custom Smart Edit Operations",
+        "properties": [
+            {
+                "name": "currentCell",
+                "kind": "REFERENCE",
+                "description": "Current selected grid cell - contains column, row and cell value information",
+                "uiLabel": "Current Cell",
+                "reference": "GridCell"
+            },
+            {
+                "name": "smartEditValue",
+                "kind": "number",
+                "description": "Smart Edit value",
+                "uiLabel": "Smart Edit Value"
+            }
+        ]
+    },
     "SpecialColumnSettings": {
         "name": "SpecialColumnSettings",
         "kind": "Interface",
@@ -11689,6 +11941,21 @@ exports.ADAPTABLE_METAMODEL = {
             }
         ]
     },
+    "StatusBarState": {
+        "name": "StatusBarState",
+        "kind": "Interface",
+        "description": "Predefined Configuration for the Adaptable Status Bar",
+        "properties": [
+            {
+                "name": "StatusBars",
+                "kind": "unknown",
+                "description": "Adaptable Status Bars to display - up to 3 can be shown",
+                "uiLabel": "Status Bars",
+                "isOptional": true,
+                "defaultValue": "null"
+            }
+        ]
+    },
     "StringFormatterOptions": {
         "name": "StringFormatterOptions",
         "kind": "Interface",
@@ -11867,15 +12134,9 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "getSharedEntities",
                 "kind": "function",
-                "description": "Retrieves all Shared Entities in Team Sharing State",
+                "description": "Retrieves all shared entities which are currently shared. It is an asynchronous operation as it leverages the `TeamSharingOptions.getSharedEntities(...)` method.",
                 "uiLabel": "Get Shared Entities"
             },
-            {
-                "name": "getTeamSharingState",
-                "kind": "function",
-                "description": "Retrieves Team Sharing section of State",
-                "uiLabel": "Get Team Sharing State"
-            },
             {
                 "name": "hasTeamSharingFullRights",
                 "kind": "function",
@@ -11888,6 +12149,18 @@ exports.ADAPTABLE_METAMODEL = {
                 "description": "Whether Team Sharing is Activated",
                 "uiLabel": "Is Team Sharing Activated"
             },
+            {
+                "name": "isTeamSharingAvailable",
+                "kind": "function",
+                "description": "Whether Team Sharing is Available to use",
+                "uiLabel": "Is Team Sharing Available"
+            },
+            {
+                "name": "setSharedEntities",
+                "kind": "function",
+                "description": "Sets the shared entities which are currently shared. It is an asynchronous operation as it leverages the `TeamSharingOptions.setSharedEntities(...)` method.",
+                "uiLabel": "Set Shared Entities"
+            },
             {
                 "name": "shareEntity",
                 "kind": "function",
@@ -11899,6 +12172,12 @@ exports.ADAPTABLE_METAMODEL = {
                 "kind": "function",
                 "description": "Opens Settings Panel with Team Sharing section selected and visible",
                 "uiLabel": "Show Team Sharing Popup"
+            },
+            {
+                "name": "unshareEntity",
+                "kind": "function",
+                "description": "Removes an Adaptable Object from the Team Share.",
+                "uiLabel": "Unshare Entity"
             }
         ]
     },
@@ -12199,15 +12478,6 @@ exports.ADAPTABLE_METAMODEL = {
         "kind": "Interface",
         "description": "Options related to managing the AdapTable ToolPanel Component",
         "properties": [
-            {
-                "name": "adaptableToolPanelTitle",
-                "kind": "string",
-                "description": "Title for AdapTable ToolPanel Component - appears vertically at side",
-                "uiLabel": "Adaptable Tool Panel Title",
-                "isOptional": true,
-                "gridInfo": "item",
-                "defaultValue": "'AdapTable'"
-            },
             {
                 "name": "customButtons",
                 "kind": "unknown",
@@ -12222,40 +12492,6 @@ exports.ADAPTABLE_METAMODEL = {
                 "uiLabel": "Custom Tool Panels",
                 "isOptional": true
             },
-            {
-                "name": "iconKey",
-                "kind": "string",
-                "description": "Key of icon to be used (beside the label) for Adaptable ToolPanel Component",
-                "uiLabel": "Icon Key",
-                "isOptional": true,
-                "gridInfo": "item",
-                "defaultValue": "'menu'"
-            },
-            {
-                "name": "maxWidth",
-                "kind": "number",
-                "description": "The max width of AdapTable ToolPanel",
-                "uiLabel": "Max Width",
-                "isOptional": true,
-                "defaultValue": "undefined"
-            },
-            {
-                "name": "minWidth",
-                "kind": "number",
-                "description": "The min width of AdapTable ToolPanel",
-                "uiLabel": "Min Width",
-                "isOptional": true,
-                "defaultValue": "var(--ab-cmp-toolpanel__width)"
-            },
-            {
-                "name": "showAdaptableToolPanel",
-                "kind": "boolean",
-                "description": "Displays Adaptable ToolPanel Component (only if AG Grid Sidebar is provided)",
-                "uiLabel": "Show Adaptable Tool Panel",
-                "isOptional": true,
-                "gridInfo": "item",
-                "defaultValue": "true"
-            },
             {
                 "name": "showToolPanelsDropdown",
                 "kind": "boolean",
@@ -12264,22 +12500,6 @@ exports.ADAPTABLE_METAMODEL = {
                 "isOptional": true,
                 "gridInfo": "item",
                 "defaultValue": "true"
-            },
-            {
-                "name": "toolPanelOrder",
-                "kind": "unknown",
-                "description": "Order of displayed ToolPanels in Sidebar",
-                "uiLabel": "Tool Panel Order",
-                "isOptional": true,
-                "defaultValue": "['filters', 'columns', 'adaptable']"
-            },
-            {
-                "name": "width",
-                "kind": "number",
-                "description": "The initial width of AdapTable ToolPanel",
-                "uiLabel": "Width",
-                "isOptional": true,
-                "defaultValue": "var(--ab-cmp-toolpanel__width)"
             }
         ]
     },
@@ -12421,11 +12641,12 @@ exports.ADAPTABLE_METAMODEL = {
         "description": "Options for managing the User Interface of AdapTable",
         "properties": [
             {
-                "name": "actionColumns",
-                "kind": "unknown",
-                "description": "Columns which contain an AdapTable Button - used for performing Actions",
-                "uiLabel": "Action Columns",
-                "isOptional": true
+                "name": "actionOptions",
+                "kind": "REFERENCE",
+                "description": "Options for creating Action Columns and Buttons",
+                "uiLabel": "Action Options",
+                "isOptional": true,
+                "reference": "ActionOptions"
             },
             {
                 "name": "applicationIcon",
@@ -12451,10 +12672,10 @@ exports.ADAPTABLE_METAMODEL = {
                 "isOptional": true
             },
             {
-                "name": "columnTypes",
+                "name": "customDisplayFormatters",
                 "kind": "unknown",
-                "description": "Optional list of Column Types - used primarily for special columns",
-                "uiLabel": "Column Types",
+                "description": "Custom Formatters to use in the Format Column Module",
+                "uiLabel": "Custom Display Formatters",
                 "isOptional": true
             },
             {