@adaptabletools/adaptable-cjs 17.0.0-canary.4 → 18.0.0-canary.1

package/src/metamodel/adaptable.metamodel.js

@@ -727,6 +727,35 @@ exports.ADAPTABLE_METAMODEL = {
         "kind": "A",
         "desc": "Column Types recognised by AdapTable; to be set in GridOptions"
     },
+    "AdaptableComment": {
+        "name": "AdaptableComment",
+        "kind": "I",
+        "desc": "Note that can be applied to a Cell in AdapTable",
+        "props": [
+            {
+                "name": "AdaptableId",
+                "kind": "s",
+                "desc": "Id of this AdapTable instance",
+                "isOpt": true
+            },
+            {
+                "name": "Author",
+                "kind": "u",
+                "desc": "Author of the Note",
+                "isOpt": true
+            },
+            {
+                "name": "Timestamp",
+                "kind": "n",
+                "desc": "When Note was made"
+            },
+            {
+                "name": "Value",
+                "kind": "s",
+                "desc": "Value of the Note"
+            }
+        ]
+    },
     "AdaptableComparerFunction": {
         "name": "AdaptableComparerFunction",
         "kind": "A",
@@ -1209,6 +1238,12 @@ exports.ADAPTABLE_METAMODEL = {
                 "noCode": "container",
                 "ref": "ColumnOptions"
             },
+            {
+                "name": "commentsOptions",
+                "kind": "u",
+                "desc": "Options for managing AdapTable Comments",
+                "isOpt": true
+            },
             {
                 "name": "containerOptions",
                 "kind": "R",
@@ -2370,6 +2405,23 @@ exports.ADAPTABLE_METAMODEL = {
         "kind": "I",
         "desc": "System Predicate definition for Badge Style"
     },
+    "BalancedGroupsKeyContext": {
+        "name": "BalancedGroupsKeyContext",
+        "kind": "I",
+        "desc": "Context used when setting a value for Balanced Row Groups",
+        "props": [
+            {
+                "name": "adaptableColumn",
+                "kind": "u",
+                "desc": "AdapTable Column being grouped"
+            },
+            {
+                "name": "params",
+                "kind": "u",
+                "desc": "AG Grid's Key Creator Params"
+            }
+        ]
+    },
     "BaseContext": {
         "name": "BaseContext",
         "kind": "I",
@@ -2560,6 +2612,11 @@ exports.ADAPTABLE_METAMODEL = {
             }
         ]
     },
+    "CellAddress": {
+        "name": "CellAddress",
+        "kind": "A",
+        "desc": "Cell that contains a Note"
+    },
     "CellColorRange": {
         "name": "CellColorRange",
         "kind": "I",
@@ -3459,6 +3516,11 @@ exports.ADAPTABLE_METAMODEL = {
                 "name": "defaultAgGridMenuItems",
                 "kind": "a",
                 "desc": "Default AG Grid Menu Items"
+            },
+            {
+                "name": "structuredAdaptableMenuItems",
+                "kind": "a",
+                "desc": "All Adaptable Menu Items sorted and grouped"
             }
         ]
     },
@@ -3481,6 +3543,11 @@ exports.ADAPTABLE_METAMODEL = {
                 "name": "defaultAgGridMenuItems",
                 "kind": "a",
                 "desc": "Default AG Grid Menu Items"
+            },
+            {
+                "name": "structuredAdaptableMenuItems",
+                "kind": "a",
+                "desc": "All Adaptable Menu Items sorted and grouped"
             }
         ]
     },
@@ -4628,7 +4695,7 @@ exports.ADAPTABLE_METAMODEL = {
                 "name": "report",
                 "kind": "R",
                 "desc": "The exported report",
-                "ref": "Report"
+                "ref": "unknown"
             },
             {
                 "name": "reportData",
@@ -5405,55 +5472,6 @@ exports.ADAPTABLE_METAMODEL = {
             }
         ]
     },
-    "FinsemblePluginOptions": {
-        "name": "FinsemblePluginOptions",
-        "kind": "I",
-        "desc": "Options required for when using the Finsemble plugin",
-        "props": [
-            {
-                "name": "applicationName",
-                "kind": "s",
-                "desc": "Application name - used to identify the application in Finsemble console",
-                "isOpt": true
-            },
-            {
-                "name": "showAdaptableAlertsAsNotifications",
-                "kind": "b",
-                "desc": "Should Adaptable's Alerts appear as Finsemble Notifications",
-                "isOpt": true,
-                "defVal": "true"
-            },
-            {
-                "name": "stateOptions",
-                "kind": "R",
-                "desc": "Options for managing Adaptable State with Finsemble State",
-                "isOpt": true,
-                "ref": "FinsemblePluginStateOptions"
-            }
-        ]
-    },
-    "FinsemblePluginStateOptions": {
-        "name": "FinsemblePluginStateOptions",
-        "kind": "I",
-        "desc": "Options for managing state while using Finsemble",
-        "props": [
-            {
-                "name": "key",
-                "kind": "s",
-                "desc": "Key used to persist/load AdapTable State in Finsemble"
-            },
-            {
-                "name": "persistInFinsemble",
-                "kind": "b",
-                "desc": "Whether to persist AdapTable State inside Finsemble"
-            },
-            {
-                "name": "topic",
-                "kind": "s",
-                "desc": "Topic used to persist/load AdapTable State in Finsemble"
-            }
-        ]
-    },
     "FlashingCellDefinition": {
         "name": "FlashingCellDefinition",
         "kind": "I",
@@ -5767,119 +5785,6 @@ exports.ADAPTABLE_METAMODEL = {
             }
         ]
     },
-    "Glue42PluginOptions": {
-        "name": "Glue42PluginOptions",
-        "kind": "I",
-        "desc": "Options for using the Glue42 Desktop plugin",
-        "props": [
-            {
-                "name": "gatewayURL",
-                "kind": "s",
-                "desc": "Gateway URL",
-                "isOpt": true
-            },
-            {
-                "name": "glue",
-                "kind": "u",
-                "desc": "Main Glue desktop object",
-                "isOpt": true
-            },
-            {
-                "name": "glue42Office",
-                "kind": "u",
-                "desc": "Main Glue42 Office object",
-                "isOpt": true
-            },
-            {
-                "name": "password",
-                "kind": "s",
-                "desc": "Password to use to login to Glue42; typically sourced from PC Credentials",
-                "isOpt": true
-            },
-            {
-                "name": "username",
-                "kind": "s",
-                "desc": "UserName to use to login to Glue42; typically sourced from PC Credentials",
-                "isOpt": true
-            }
-        ]
-    },
-    "Glue42Report": {
-        "name": "Glue42Report",
-        "kind": "I",
-        "desc": "Glue42 report - currently just contains name of Report",
-        "props": [
-            {
-                "name": "ReportName",
-                "kind": "s",
-                "desc": "The Report's name (as exists in Export State)"
-            }
-        ]
-    },
-    "Glue42Schedule": {
-        "name": "Glue42Schedule",
-        "kind": "I",
-        "desc": "Defines Glue42 Scheduled Report; used in Schedule Module (where State is stored)",
-        "props": [
-            {
-                "name": "Glue42Report",
-                "kind": "R",
-                "desc": "The Glue42 Report which will be sent when the Schedule runs",
-                "ref": "Glue42Report"
-            },
-            {
-                "name": "Transmission",
-                "kind": "'Snapshot' | 'Live Data'",
-                "desc": "Whether its a one-off or 'streaming' transmission"
-            }
-        ]
-    },
-    "Glue42State": {
-        "name": "Glue42State",
-        "kind": "I",
-        "desc": "Internal State used by AdapTable for managing the Glue42 plugin",
-        "props": [
-            {
-                "name": "CurrentLiveGlue42Report",
-                "kind": "R",
-                "desc": "Which Glue42 Report is currently live",
-                "isOpt": true,
-                "ref": "Glue42Report"
-            },
-            {
-                "name": "Glue42LoginErrorMessage",
-                "kind": "s",
-                "desc": "Message to show when Login Fails",
-                "isOpt": true
-            },
-            {
-                "name": "IsGlue42Available",
-                "kind": "b",
-                "desc": "Whether Glue42 is available",
-                "isOpt": true
-            },
-            {
-                "name": "IsGlue42Running",
-                "kind": "b",
-                "desc": "Whether Glue42 is running",
-                "isOpt": true
-            }
-        ]
-    },
-    "Glue42WebPluginOptions": {
-        "name": "Glue42WebPluginOptions",
-        "kind": "I",
-        "desc": "Options for using the Glue42 Web plugin",
-        "props": [
-            {
-                "name": "showAdaptableAlertsAsNotifications",
-                "kind": "b",
-                "desc": "Converts AdapTable Alerts configured to display in popup as Glue42 Notifications",
-                "isOpt": true,
-                "defVal": "true"
-            }
-        ]
-    },
     "GradientStyle": {
         "name": "GradientStyle",
         "kind": "I",
@@ -5987,6 +5892,11 @@ exports.ADAPTABLE_METAMODEL = {
             }
         ]
     },
+    "GridFilterEditor": {
+        "name": "GridFilterEditor",
+        "kind": "A",
+        "desc": "List of all the Module buttons Adaptable provides - each Module has a popup for which this is a shortcut button"
+    },
     "GridFilterOptions": {
         "name": "GridFilterOptions",
         "kind": "I",
@@ -5994,10 +5904,11 @@ exports.ADAPTABLE_METAMODEL = {
         "props": [
             {
                 "name": "availableFilterEditors",
-                "kind": "'ExpressionEditor' | 'QueryBuilder' | 'Both'",
-                "desc": "Where Grid Filter can be edited - Expression Editor, Query Builder or Both",
+                "kind": "R",
+                "desc": "Which UI Components can be used to edit a Grid Filter: Expression Editor, Query Builder or Both",
                 "isOpt": true,
-                "defVal": "'Both'"
+                "defVal": "['ExpressionEditor', 'QueryBuilder']",
+                "ref": "unknown"
             },
             {
                 "name": "clearGridFilterOnStartUp",
@@ -6054,6 +5965,12 @@ exports.ADAPTABLE_METAMODEL = {
                 "noCode": "item",
                 "defVal": "true"
             },
+            {
+                "name": "balancedGroupsKey",
+                "kind": "u",
+                "desc": "Value to use for 'Balanced Groups' (string columns only)",
+                "isOpt": true
+            },
             {
                 "name": "restoreUngroupedColumns",
                 "kind": "b",
@@ -6069,12 +5986,6 @@ exports.ADAPTABLE_METAMODEL = {
                 "isOpt": true,
                 "gridInfo": "item",
                 "defVal": "false"
-            },
-            {
-                "name": "unbalancedGroupsKey",
-                "kind": "u",
-                "desc": "Value to use for 'Unbalanced Groups' (string columns)",
-                "isOpt": true
             }
         ]
     },
@@ -6785,24 +6696,7 @@ exports.ADAPTABLE_METAMODEL = {
     "NotableCellContext": {
         "name": "NotableCellContext",
         "kind": "I",
-        "desc": "Context used when determining if a Note can be added to a Cell",
-        "props": [
-            {
-                "name": "columnId",
-                "kind": "s",
-                "desc": "Column where Note will be displayed"
-            },
-            {
-                "name": "primaryKeyValue",
-                "kind": "s",
-                "desc": "Value in Primary Key Column"
-            }
-        ]
-    },
-    "NoteGridCell": {
-        "name": "NoteGridCell",
-        "kind": "A",
-        "desc": "Cell that contains a Note"
+        "desc": "Context used when determining if a Note can be added to a Cell"
     },
     "NotesOptions": {
         "name": "NotesOptions",
@@ -7383,6 +7277,13 @@ exports.ADAPTABLE_METAMODEL = {
                 "isOpt": true,
                 "ref": "NamedQueryState"
             },
+            {
+                "name": "Notes",
+                "kind": "R",
+                "desc": "Collection of notes that can be edited on cell level",
+                "isOpt": true,
+                "ref": "unknown"
+            },
             {
                 "name": "PlusMinus",
                 "kind": "R",
@@ -7567,7 +7468,7 @@ exports.ADAPTABLE_METAMODEL = {
                 "name": "report",
                 "kind": "R",
                 "desc": "Report being exported",
-                "ref": "Report"
+                "ref": "unknown"
             }
         ]
     },
@@ -7640,15 +7541,6 @@ exports.ADAPTABLE_METAMODEL = {
                 "noCode": "item",
                 "defVal": "'mouseenter'"
             },
-            {
-                "name": "quickFilterValuesTrigger",
-                "kind": "'mouseenter' | 'click'",
-                "desc": "Open Quick Filter Values dropdown with mouse hover or click",
-                "isOpt": true,
-                "gridInfo": "item",
-                "noCode": "item",
-                "defVal": "'mouseenter'"
-            },
             {
                 "name": "quickFilterValuesWidth",
                 "kind": "'auto' | number",
@@ -7868,8 +7760,8 @@ exports.ADAPTABLE_METAMODEL = {
             }
         ]
     },
-    "Report": {
-        "name": "Report",
+    "Report_2": {
+        "name": "Report_2",
         "kind": "I",
         "desc": "A Report which can export data from AdapTable",
         "props": [
@@ -7920,7 +7812,7 @@ exports.ADAPTABLE_METAMODEL = {
                 "name": "report",
                 "kind": "R",
                 "desc": "Definition of Report being Run",
-                "ref": "Report"
+                "ref": "unknown"
             },
             {
                 "name": "reportData",
@@ -8155,12 +8047,6 @@ exports.ADAPTABLE_METAMODEL = {
         "kind": "I",
         "desc": "Predefined Configuration for the Schedule Module",
         "props": [
-            {
-                "name": "Glue42Schedules",
-                "kind": "a",
-                "desc": "Schedules connected to Glue42 exports - available if Glue42 plugin is running",
-                "isOpt": true
-            },
             {
                 "name": "IPushPullSchedules",
                 "kind": "a",
@@ -8228,6 +8114,40 @@ exports.ADAPTABLE_METAMODEL = {
             }
         ]
     },
+    "ServerValidationResult": {
+        "name": "ServerValidationResult",
+        "kind": "I",
+        "desc": "Used for Server Validation ie. after an edit in AG Grid which must be checked on Server",
+        "props": [
+            {
+                "name": "messageType",
+                "kind": "R",
+                "desc": "Type of Message to Display",
+                "isOpt": true,
+                "defVal": "Info",
+                "ref": "AdaptableMessageType"
+            },
+            {
+                "name": "newCellValue",
+                "kind": "u",
+                "desc": "Cell Value to use for after Server Validation",
+                "isOpt": true
+            },
+            {
+                "name": "validationHeader",
+                "kind": "s",
+                "desc": "Header to diplay with validation",
+                "isOpt": true,
+                "defVal": "'Server Validation Message',"
+            },
+            {
+                "name": "validationMessage",
+                "kind": "s",
+                "desc": "Message to diplay with validation",
+                "isOpt": true
+            }
+        ]
+    },
     "SetPrimaryKeyValueContext": {
         "name": "SetPrimaryKeyValueContext",
         "kind": "I",
@@ -9014,23 +8934,6 @@ exports.ADAPTABLE_METAMODEL = {
             }
         ]
     },
-    "UnbalancedGroupsKeyContext": {
-        "name": "UnbalancedGroupsKeyContext",
-        "kind": "I",
-        "desc": "Context used when setting a value for Unbalanced Row Groups",
-        "props": [
-            {
-                "name": "adaptableColumn",
-                "kind": "u",
-                "desc": "AdapTable Column being grouped"
-            },
-            {
-                "name": "params",
-                "kind": "u",
-                "desc": "AG Grid's Key Creator Params"
-            }
-        ]
-    },
     "UserColumnMenuItem": {
         "name": "UserColumnMenuItem",
         "kind": "I",
@@ -9315,40 +9218,6 @@ exports.ADAPTABLE_METAMODEL = {
             }
         ]
     },
-    "ValidationResult": {
-        "name": "ValidationResult",
-        "kind": "I",
-        "desc": "Used for Server Validation ie. after an edit in AG Grid which must be checked on Server",
-        "props": [
-            {
-                "name": "MessageType",
-                "kind": "R",
-                "desc": "Type of Message to Display",
-                "isOpt": true,
-                "defVal": "Info",
-                "ref": "AdaptableMessageType"
-            },
-            {
-                "name": "NewValue",
-                "kind": "u",
-                "desc": "Cell Value to use for after Server Validation",
-                "isOpt": true
-            },
-            {
-                "name": "ValidationHeader",
-                "kind": "s",
-                "desc": "Header to diplay with validation",
-                "isOpt": true,
-                "defVal": "'Server Validation Message',"
-            },
-            {
-                "name": "ValidationMessage",
-                "kind": "s",
-                "desc": "Message to diplay with validation",
-                "isOpt": true
-            }
-        ]
-    },
     "ValuationContext": {
         "name": "ValuationContext",
         "kind": "A",
@@ -9415,6 +9284,15 @@ exports.ADAPTABLE_METAMODEL = {
                 "isOpt": true,
                 "gridInfo": "item",
                 "defVal": "false"
+            },
+            {
+                "name": "valuesFilterTrigger",
+                "kind": "'mouseenter' | 'click'",
+                "desc": "Open Values dropdown with mouse hover or click",
+                "isOpt": true,
+                "gridInfo": "item",
+                "noCode": "item",
+                "defVal": "'mouseenter'"
             }
         ]
     },

package/src/parser/src/parser.d.ts

@@ -0,0 +1,2 @@
+declare var parser: any;
+export default parser;