@adaptabletools/adaptable 11.0.0-canary.6 → 11.0.0-canary.7

package/src/metamodel/adaptable.metamodel.js

@@ -152,6 +152,11 @@ exports.ADAPTABLE_METAMODEL = {
             }
         ]
     },
+    "AdaptableAlertQuery": {
+        "name": "AdaptableAlertQuery",
+        "kind": "TypeAlias",
+        "description": "Alert Query which may be either a Boolean, Observable or AggregatedBoolean Expression"
+    },
     "AdaptableApi": {
         "name": "AdaptableApi",
         "kind": "Interface",
@@ -474,6 +479,11 @@ exports.ADAPTABLE_METAMODEL = {
             }
         ]
     },
+    "AdaptableCalculatedColumnQuery": {
+        "name": "AdaptableCalculatedColumnQuery",
+        "kind": "TypeAlias",
+        "description": "Calculated Column Query which may be a Scalar or an AggregatedScalar Expression"
+    },
     "AdaptableColumn": {
         "name": "AdaptableColumn",
         "kind": "Interface",
@@ -922,6 +932,14 @@ exports.ADAPTABLE_METAMODEL = {
                 "gridInfo": "item",
                 "defaultValue": "'adaptable_id'"
             },
+            {
+                "name": "adaptableQLOptions",
+                "kind": "REFERENCE",
+                "description": "Options for managing AdapTableQL",
+                "uiLabel": "Adaptable QL Options",
+                "isOptional": true,
+                "reference": "unknown"
+            },
             {
                 "name": "adaptableStateKey",
                 "kind": "string",
@@ -1109,15 +1127,6 @@ exports.ADAPTABLE_METAMODEL = {
                 "gridInfo": "item",
                 "defaultValue": "n/a (Mandatory)"
             },
-            {
-                "name": "queryLanguageOptions",
-                "kind": "REFERENCE",
-                "description": "Options for managing queries in AdapTableQL",
-                "uiLabel": "Query Language Options",
-                "isOptional": true,
-                "gridInfo": "container",
-                "reference": "QueryLanguageOptions"
-            },
             {
                 "name": "searchOptions",
                 "kind": "REFERENCE",
@@ -1798,7 +1807,7 @@ exports.ADAPTABLE_METAMODEL = {
                 "kind": "REFERENCE",
                 "description": "When Alert should be triggered",
                 "uiLabel": "Rule",
-                "reference": "unknown"
+                "reference": "AlertRule"
             },
             {
                 "name": "Scope",
@@ -1940,6 +1949,11 @@ exports.ADAPTABLE_METAMODEL = {
             }
         ]
     },
+    "AlertRule": {
+        "name": "AlertRule",
+        "kind": "TypeAlias",
+        "description": "The Alert Rule defined by either an AdaptablePredicate or an AdaptableQuery"
+    },
     "AlertState": {
         "name": "AlertState",
         "kind": "Interface",
@@ -2156,10 +2170,10 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "Query",
                 "kind": "REFERENCE",
-                "description": "Scalar Expression used by AdapTableQL to evaluate Column's value",
+                "description": "Scalar/AggregatedScalar Query used by AdapTableQL to evaluate Column's value",
                 "uiLabel": "Query",
                 "isOptional": true,
-                "reference": "unknown"
+                "reference": "AdaptableCalculatedColumnQuery"
             }
         ]
     },
@@ -2186,12 +2200,6 @@ exports.ADAPTABLE_METAMODEL = {
                 "description": "Edits given Calculated Column",
                 "uiLabel": "Edit Calculated Column"
             },
-            {
-                "name": "editCalculatedColumnExpression",
-                "kind": "function",
-                "description": "Replaces Expression in given Calculated Column with new value",
-                "uiLabel": "Edit Calculated Column Expression"
-            },
             {
                 "name": "editCalculatedColumns",
                 "kind": "function",
@@ -2207,7 +2215,7 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "getCalculatedColumnById",
                 "kind": "function",
-                "description": "Retrieves Calculated column by id",
+                "description": "Retrieves Calculated Column by the unique identifier of the Adaptable Object in the CalculatedColumnState",
                 "uiLabel": "Get Calculated Column By Id"
             },
             {
@@ -5113,6 +5121,99 @@ exports.ADAPTABLE_METAMODEL = {
         "kind": "TypeAlias",
         "description": "The javascript function which is invoked by an AdapTableQL Function"
     },
+    "ExpressionOptions": {
+        "name": "ExpressionOptions",
+        "kind": "Interface",
+        "description": "Options for managing Expressions using AdapTableQL",
+        "properties": [
+            {
+                "name": "defaultAggregatedBooleanFunctions",
+                "kind": "REFERENCE",
+                "description": "Aggregated Boolean Expression Functions available in AdapTableQL",
+                "uiLabel": "Default Aggregated Boolean Functions",
+                "isOptional": true,
+                "gridInfo": "item",
+                "defaultValue": "null (sets all)",
+                "reference": "unknown"
+            },
+            {
+                "name": "defaultAggregatedScalarFunctions",
+                "kind": "REFERENCE",
+                "description": "Aggregated Scalar Expression Functions available in AdapTableQL",
+                "uiLabel": "Default Aggregated Scalar Functions",
+                "isOptional": true,
+                "gridInfo": "item",
+                "defaultValue": "null (sets all)",
+                "reference": "unknown"
+            },
+            {
+                "name": "defaultBooleanFunctions",
+                "kind": "REFERENCE",
+                "description": "Boolean Expression Functions available in AdapTableQL",
+                "uiLabel": "Default Boolean Functions",
+                "isOptional": true,
+                "gridInfo": "item",
+                "defaultValue": "null (sets all)",
+                "reference": "unknown"
+            },
+            {
+                "name": "defaultObservableFunctions",
+                "kind": "REFERENCE",
+                "description": "Observable Expression Functions available in AdapTableQL",
+                "uiLabel": "Default Observable Functions",
+                "isOptional": true,
+                "gridInfo": "item",
+                "defaultValue": "null (sets all)",
+                "reference": "unknown"
+            },
+            {
+                "name": "defaultScalarFunctions",
+                "kind": "REFERENCE",
+                "description": "Scalar Expression Functions available in AdapTableQL",
+                "uiLabel": "Default Scalar Functions",
+                "isOptional": true,
+                "gridInfo": "item",
+                "defaultValue": "null (sets all)",
+                "reference": "unknown"
+            },
+            {
+                "name": "maxTimeframeSize",
+                "kind": "number",
+                "description": "Maximum time (in milliseconds) to hold a Data Change event in a trailing timeframe (see observableExpressionFunctions); value is capped at 86400000 (~24 hours) for performance reasons",
+                "uiLabel": "Max Timeframe Size",
+                "isOptional": true,
+                "gridInfo": "item",
+                "defaultValue": "28800000 (~8 hours)"
+            },
+            {
+                "name": "moduleExpressionFunctions",
+                "kind": "unknown",
+                "description": "Module specific ExpressionFunctions; if not defined, it falls back to the defined default values",
+                "uiLabel": "Module Expression Functions",
+                "isOptional": true,
+                "gridInfo": "item",
+                "defaultValue": "undefined (defaults to default values)"
+            },
+            {
+                "name": "performExpressionValidation",
+                "kind": "boolean",
+                "description": "Validate Expressions before they can be run or saved",
+                "uiLabel": "Perform Expression Validation",
+                "isOptional": true,
+                "gridInfo": "item",
+                "defaultValue": "true"
+            },
+            {
+                "name": "queryableColumns",
+                "kind": "unknown",
+                "description": "Columns that can be included in AdapTableQL Expressions; leave unset to include **ALL**, provide empty array to set **NONE**",
+                "uiLabel": "Queryable Columns",
+                "isOptional": true,
+                "gridInfo": "item",
+                "defaultValue": "undefined"
+            }
+        ]
+    },
     "FDC3Context": {
         "name": "FDC3Context",
         "kind": "Interface",
@@ -6255,15 +6356,6 @@ exports.ADAPTABLE_METAMODEL = {
                 "gridInfo": "item",
                 "defaultValue": "true"
             },
-            {
-                "name": "caseSensitiveTextComparisons",
-                "kind": "boolean",
-                "description": "Perform case-sensitive text comparisons in all search and filter operations: QuickSearch, Filters, Query, Predicates",
-                "uiLabel": "Case Sensitive Text Comparisons",
-                "isOptional": true,
-                "gridInfo": "item",
-                "defaultValue": "false"
-            },
             {
                 "name": "cellSummaryOperations",
                 "kind": "unknown",
@@ -6963,9 +7055,21 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "selectCellRange",
                 "kind": "function",
-                "description": "Selects a group of cells in a given range",
+                "description": "Selects a group of cells in a given range - provide either primary keys or row indexes",
                 "uiLabel": "Select Cell Range"
             },
+            {
+                "name": "selectColumn",
+                "kind": "function",
+                "description": "Selects a Column in AG Grid",
+                "uiLabel": "Select Column"
+            },
+            {
+                "name": "selectColumns",
+                "kind": "function",
+                "description": "Selects Columns in AG Grid",
+                "uiLabel": "Select Columns"
+            },
             {
                 "name": "selectNode",
                 "kind": "function",
@@ -8930,7 +9034,7 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "getCurrentQuery",
                 "kind": "function",
-                "description": "Retuns the Current Query",
+                "description": "Returns the Current Query",
                 "uiLabel": "Get Current Query"
             },
             {
@@ -8988,6 +9092,12 @@ exports.ADAPTABLE_METAMODEL = {
         "kind": "Interface",
         "description": "Manages AdapTableQL (Query Language)",
         "properties": [
+            {
+                "name": "getAdaptableQueryExpression",
+                "kind": "function",
+                "description": "Returns the Expression string of the given AdaptableQuery, which may be either a Boolean, an AggregatedBoolean, a Scalar, an AggregatedScalar or an ObservableExpression expression",
+                "uiLabel": "Get Adaptable Query Expression"
+            },
             {
                 "name": "getASTForExpression",
                 "kind": "function",
@@ -9018,6 +9128,12 @@ exports.ADAPTABLE_METAMODEL = {
                 "description": "Whether the given AggregatedBooleanExpression is valid",
                 "uiLabel": "Is Valid Aggregated Boolean Expression"
             },
+            {
+                "name": "isValidAggregatedScalarExpression",
+                "kind": "function",
+                "description": "Whether the given AggregatedScalarExpression is valid",
+                "uiLabel": "Is Valid Aggregated Scalar Expression"
+            },
             {
                 "name": "isValidBooleanExpression",
                 "kind": "function",
@@ -9032,89 +9148,6 @@ exports.ADAPTABLE_METAMODEL = {
             }
         ]
     },
-    "QueryLanguageOptions": {
-        "name": "QueryLanguageOptions",
-        "kind": "Interface",
-        "description": "Options for managing Expressions using AdapTableQL",
-        "properties": [
-            {
-                "name": "defaultAggregatedBooleanFunctions",
-                "kind": "REFERENCE",
-                "description": "Aggregated Boolean Expression Functions available in AdapTableQL",
-                "uiLabel": "Default Aggregated Boolean Functions",
-                "isOptional": true,
-                "gridInfo": "item",
-                "defaultValue": "null (sets all)",
-                "reference": "unknown"
-            },
-            {
-                "name": "defaultBooleanFunctions",
-                "kind": "REFERENCE",
-                "description": "Boolean Expression Functions available in AdapTableQL",
-                "uiLabel": "Default Boolean Functions",
-                "isOptional": true,
-                "gridInfo": "item",
-                "defaultValue": "null (sets all)",
-                "reference": "unknown"
-            },
-            {
-                "name": "defaultObservableFunctions",
-                "kind": "REFERENCE",
-                "description": "Observable Expression Functions available in AdapTableQL",
-                "uiLabel": "Default Observable Functions",
-                "isOptional": true,
-                "gridInfo": "item",
-                "defaultValue": "null (sets all)",
-                "reference": "unknown"
-            },
-            {
-                "name": "defaultScalarFunctions",
-                "kind": "REFERENCE",
-                "description": "Scalar Expression Functions available in AdapTableQL",
-                "uiLabel": "Default Scalar Functions",
-                "isOptional": true,
-                "gridInfo": "item",
-                "defaultValue": "null (sets all)",
-                "reference": "unknown"
-            },
-            {
-                "name": "maxTimeframeSize",
-                "kind": "number",
-                "description": "Maximum time (in milliseconds) to hold a Data Change event in a trailing timeframe (see observableExpressionFunctions); value is capped at 86400000 (~24 hours) for performance reasons",
-                "uiLabel": "Max Timeframe Size",
-                "isOptional": true,
-                "gridInfo": "item",
-                "defaultValue": "28800000 (~8 hours)"
-            },
-            {
-                "name": "moduleExpressionFunctions",
-                "kind": "unknown",
-                "description": "Module specific ExpressionFunctions; if not defined, it falls back to the defined default values",
-                "uiLabel": "Module Expression Functions",
-                "isOptional": true,
-                "gridInfo": "item",
-                "defaultValue": "undefined (defaults to default values)"
-            },
-            {
-                "name": "performExpressionValidation",
-                "kind": "boolean",
-                "description": "Validate Expressions before they can be run or saved",
-                "uiLabel": "Perform Expression Validation",
-                "isOptional": true,
-                "gridInfo": "item",
-                "defaultValue": "true"
-            },
-            {
-                "name": "queryableColumns",
-                "kind": "unknown",
-                "description": "Columns that can be included in AdapTableQL Expressions; leave unset to include **ALL**, provide empty array to set **NONE**",
-                "uiLabel": "Queryable Columns",
-                "isOptional": true,
-                "gridInfo": "item",
-                "defaultValue": "undefined"
-            }
-        ]
-    },
     "QueryState": {
         "name": "QueryState",
         "kind": "Interface",
@@ -9885,16 +9918,6 @@ exports.ADAPTABLE_METAMODEL = {
                 "isOptional": true,
                 "gridInfo": "item",
                 "defaultValue": "'Search'"
-            },
-            {
-                "name": "serverSearchOptions",
-                "kind": "REFERENCE",
-                "description": "Which searching and filtering options, if any, should take place on server",
-                "uiLabel": "Server Search Options",
-                "isOptional": true,
-                "gridInfo": "item",
-                "defaultValue": "undefined",
-                "reference": "unknown"
             }
         ]
     },
@@ -9959,13 +9982,13 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "showCustomSettingsPanel",
                 "kind": "function",
-                "description": "Opens a the settings panel to the custom module",
+                "description": "Opens Settings Panel with the Custom Settings Panel, provided by name, displayed",
                 "uiLabel": "Show Custom Settings Panel"
             },
             {
                 "name": "showSettingsPanel",
                 "kind": "function",
-                "description": "Opens settings panel to specified module, when not specified it opens the first available module",
+                "description": "Opens Settings Panel and displays specified Module (if provided) or first available one",
                 "uiLabel": "Show Settings Panel"
             }
         ]
@@ -10209,7 +10232,7 @@ exports.ADAPTABLE_METAMODEL = {
     "SpecialColumnSettings": {
         "name": "SpecialColumnSettings",
         "kind": "Interface",
-        "description": "Base Settings for SpecialColumns",
+        "description": "Base Settings for Calculated Columns and FreeText Columns",
         "properties": [
             {
                 "name": "Aggregatable",
@@ -10294,19 +10317,19 @@ exports.ADAPTABLE_METAMODEL = {
     "StateOptions": {
         "name": "StateOptions",
         "kind": "Interface",
-        "description": "Options related to state hydration/dehydration - allows users to intercept state persistence and state loading with custom functionality.",
+        "description": "Options related to Adaptable State hydration/dehydration - allows users to intercept state persistence and state loading with custom functionality",
         "properties": [
             {
                 "name": "applyState",
                 "kind": "unknown",
-                "description": "Allows hooking into AdaptableState hydration",
+                "description": "Allows hooking into Adaptable State hydration",
                 "uiLabel": "Apply State",
                 "isOptional": true
             },
             {
                 "name": "clearState",
                 "kind": "REFERENCE",
-                "description": "Allows clearing of remote state.",
+                "description": "Allows clearing of remote Adaptable State",
                 "uiLabel": "Clear State",
                 "isOptional": true,
                 "reference": "unknown"
@@ -10314,7 +10337,7 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "debounceStateDelay",
                 "kind": "number",
-                "description": "Delay (in ms) to debounce saveState/persistState calls enabling grouping multiple sequential calls in single one (e.g. elevator doors)",
+                "description": "Delay (in ms) to debounce `saveState` / `persistState` calls enabling grouping multiple sequential calls in single one (e.g. elevator doors)",
                 "uiLabel": "Debounce State Delay",
                 "isOptional": true,
                 "defaultValue": "400"
@@ -10322,7 +10345,7 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "loadState",
                 "kind": "REFERENCE",
-                "description": "Allows the customization of state loading.",
+                "description": "Allows the customization of Adaptable State loading",
                 "uiLabel": "Load State",
                 "isOptional": true,
                 "reference": "AdaptableLoadStateFunction"
@@ -10330,7 +10353,7 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "persistState",
                 "kind": "REFERENCE",
-                "description": "Allows the customization of state persistence.",
+                "description": "Allows the customization of state persistence",
                 "uiLabel": "Persist State",
                 "isOptional": true,
                 "reference": "AdaptablePersistStateFunction"
@@ -10338,7 +10361,7 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "saveState",
                 "kind": "REFERENCE",
-                "description": "Allows the customization of the state that is going to be persisted",
+                "description": "Allows the customization of the Adaptable State that is going to be persisted",
                 "uiLabel": "Save State",
                 "isOptional": true,
                 "reference": "unknown"

package/src/types.d.ts

@@ -17,7 +17,7 @@ export type { OpenFinPluginOptions } from './AdaptableOptions/OpenFinPluginOptio
 export type { FinancePluginOptions, WeightedAverageColumn, InstrumentColumn, } from './AdaptableOptions/FinancePluginOptions';
 export type { DateInputOptions } from './AdaptableOptions/DateInputOptions';
 export type { FilterOptions } from './AdaptableOptions/FilterOptions';
-export type { SearchOptions, ServerSearchOption, ServerSearchOptions, } from './AdaptableOptions/SearchOptions';
+export type { SearchOptions } from './AdaptableOptions/SearchOptions';
 export type { AdaptablePersistStateFunction, AdaptableStateFunctionConfig, AdaptableLoadStateFunction, StateOptions, } from './AdaptableOptions/StateOptions';
 export type { AccessLevel, Entitlement } from './PredefinedConfig/Common/Entitlement';
 export type { FilterActionOnDataChange } from './PredefinedConfig/Common/FilterActionOnDataChange';
@@ -28,7 +28,7 @@ export type { UserInterfaceOptions, CellValuesList, ActionColumnButtonContext, A
 export type { MenuOptions } from './AdaptableOptions/MenuOptions';
 export type { CustomSettingsPanel, SettingsPanelOptions, } from './AdaptableOptions/SettingsPanelOptions';
 export type { EntitlementOptions } from './AdaptableOptions/EntitlementOptions';
-export type { QueryLanguageOptions, ModuleExpressionFunctions, } from './AdaptableOptions/QueryLanguageOptions';
+export type { ExpressionOptions, ModuleExpressionFunctions, AdaptableQLOptions, } from './AdaptableOptions/AdaptableQLOptions';
 export type { DataChangeHistoryOptions } from './AdaptableOptions/DataChangeHistoryOptions';
 export type { AdaptableApi } from './Api/AdaptableApi';
 export type { AlertApi } from './Api/AlertApi';
@@ -88,10 +88,10 @@ export type { ThemeChangedInfo } from './Api/Events/ThemeChanged';
 export type { DashboardChangedInfo } from './Api/Events/DashboardChanged';
 export type { AdaptableStateChangedInfo } from './Api/Events/AdaptableStateChanged';
 export type { AdaptableState } from './PredefinedConfig/AdaptableState';
-export type { AlertDefinition, AlertProperties, AlertState, AlertButtonForm, AlertButton, AdaptableAlertAction, AlertDefinitionPredicate, } from './PredefinedConfig/AlertState';
+export type { AlertDefinition, AlertProperties, AlertState, AlertButtonForm, AlertButton, AdaptableAlertAction, AlertDefinitionPredicate, AlertRule, AdaptableAlertQuery, } from './PredefinedConfig/AlertState';
 export type { ApplicationDataEntry, ApplicationState } from './PredefinedConfig/ApplicationState';
 export type { SpecialColumnSettings } from './PredefinedConfig/Common/SpecialColumnSettings';
-export type { CalculatedColumn, CalculatedColumnSettings, CalculatedColumnState, } from './PredefinedConfig/CalculatedColumnState';
+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';
@@ -119,7 +119,7 @@ export type { AdaptableButton } from './PredefinedConfig/Common/AdaptableButton'
 export type { AdaptableMenuItem, UserMenuItem, ColumnMenuContext, ContextMenuContext, } from './PredefinedConfig/Common/Menu';
 export type { Schedule } from './PredefinedConfig/Common/Schedule';
 export type { ButtonStyle } from './PredefinedConfig/Common/ButtonStyle';
-export type { AdaptableModule, AdaptableToolPanel } from './PredefinedConfig/Common/Types';
+export type { AdaptableModule, AdaptableToolPanel, AdaptableQLModule, } from './PredefinedConfig/Common/Types';
 export type { ConditionalStyle, ConditionalStyleRule, ConditionalStyleState, } from './PredefinedConfig/ConditionalStyleState';
 export type { CustomSort, CustomSortState } from './PredefinedConfig/CustomSortState';
 export type { DashboardState, DashboardTab, AdaptableCoordinate, } from './PredefinedConfig/DashboardState';

package/version.d.ts

@@ -1,2 +1,2 @@
-declare const _default: "11.0.0-canary.6";
+declare const _default: "11.0.0-canary.7";
 export default _default;

package/version.js

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