@adaptabletools/adaptable 11.0.0-canary.4 → 11.0.0-canary.5

package/src/metamodel/adaptable.metamodel.js

@@ -296,13 +296,6 @@ exports.ADAPTABLE_METAMODEL = {
                 "uiLabel": "Grid Api",
                 "reference": "GridApi"
             },
-            {
-                "name": "internalApi",
-                "kind": "REFERENCE",
-                "description": "Api methods used *internally* within AdapTable.",
-                "uiLabel": "Internal Api",
-                "reference": "unknown"
-            },
             {
                 "name": "layoutApi",
                 "kind": "REFERENCE",
@@ -931,6 +924,15 @@ exports.ADAPTABLE_METAMODEL = {
                 "gridInfo": "item",
                 "defaultValue": "`adaptableId` value"
             },
+            {
+                "name": "alertOptions",
+                "kind": "REFERENCE",
+                "description": "Options for managing Alerts in AdapTable",
+                "uiLabel": "Alert Options",
+                "isOptional": true,
+                "gridInfo": "container",
+                "reference": "AlertOptions"
+            },
             {
                 "name": "autogeneratePrimaryKey",
                 "kind": "boolean",
@@ -1061,6 +1063,13 @@ exports.ADAPTABLE_METAMODEL = {
                 "gridInfo": "container",
                 "reference": "MenuOptions"
             },
+            {
+                "name": "modules",
+                "kind": "unknown",
+                "description": "AG Grid Modules that should be provided - needs to be provided separately",
+                "uiLabel": "Modules",
+                "isOptional": true
+            },
             {
                 "name": "notificationsOptions",
                 "kind": "REFERENCE",
@@ -1812,6 +1821,61 @@ exports.ADAPTABLE_METAMODEL = {
         "kind": "TypeAlias",
         "description": "Form to show in an Alert"
     },
+    "AlertOptions": {
+        "name": "AlertOptions",
+        "kind": "Interface",
+        "description": "Options related to Alerts in Adaptable.",
+        "properties": [
+            {
+                "name": "actionHandlers",
+                "kind": "unknown",
+                "description": "onClick Handlers for Alert Buttons (defined in Alert State)",
+                "uiLabel": "Action Handlers",
+                "isOptional": true
+            },
+            {
+                "name": "alertForms",
+                "kind": "unknown",
+                "description": "Full definitions of Alert Forms - the names of which are provided in Alert State",
+                "uiLabel": "Alert Forms",
+                "isOptional": true
+            },
+            {
+                "name": "alertMessageText",
+                "kind": "unknown",
+                "description": "Function providing Message to display in Alert; if empty, AdapTable provides dynamically",
+                "uiLabel": "Alert Message Text",
+                "isOptional": true
+            },
+            {
+                "name": "cellHighlightDuration",
+                "kind": "number",
+                "description": "How long (in ms) a cell will be highlighted",
+                "uiLabel": "Cell Highlight Duration",
+                "isOptional": true,
+                "gridInfo": "item",
+                "defaultValue": "3000"
+            },
+            {
+                "name": "dataChangeDetectionPolicy",
+                "kind": "unknown",
+                "description": "Whether Alert rule is evaluated against the `rawValue` or `formattedValue` of the changed cell data",
+                "uiLabel": "Data Change Detection Policy",
+                "isOptional": true,
+                "gridInfo": "item",
+                "defaultValue": "'rawValue'"
+            },
+            {
+                "name": "maxAlertsInStore",
+                "kind": "number",
+                "description": "How many alerts held in State at any one time; when limit is breached, oldest alert will be removed",
+                "uiLabel": "Max Alerts In Store",
+                "isOptional": true,
+                "gridInfo": "item",
+                "defaultValue": "20"
+            }
+        ]
+    },
     "AlertProperties": {
         "name": "AlertProperties",
         "kind": "Interface",
@@ -1855,9 +1919,10 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "PreventEdit",
                 "kind": "boolean",
-                "description": "Automatically prevent any cell edit which triggered the Alert (i.e. validation)   false",
+                "description": "Automatically prevent any cell edit which triggered the Alert (i.e. validation)",
                 "uiLabel": "Prevent Edit",
-                "isOptional": true
+                "isOptional": true,
+                "defaultValue": "false"
             },
             {
                 "name": "ShowInDiv",
@@ -1878,8 +1943,7 @@ exports.ADAPTABLE_METAMODEL = {
                 "kind": "unknown",
                 "description": "Alert Definitions - will trigger Alerts when rule is met",
                 "uiLabel": "Alert Definitions",
-                "isOptional": true,
-                "defaultValue": "null"
+                "isOptional": true
             }
         ]
     },
@@ -2215,8 +2279,7 @@ exports.ADAPTABLE_METAMODEL = {
                 "kind": "unknown",
                 "description": "Collection of Calculated Columns",
                 "uiLabel": "Calculated Columns",
-                "isOptional": true,
-                "defaultValue": "empty"
+                "isOptional": true
             }
         ]
     },
@@ -3264,7 +3327,7 @@ exports.ADAPTABLE_METAMODEL = {
             },
             {
                 "name": "modalContainer",
-                "kind": "string",
+                "kind": "unknown",
                 "description": "Name of div where modals appear (if null, will be centre of page)",
                 "uiLabel": "Modal Container",
                 "isOptional": true,
@@ -3527,8 +3590,7 @@ exports.ADAPTABLE_METAMODEL = {
                 "kind": "unknown",
                 "description": "Collection of Custom Sort objects.",
                 "uiLabel": "Custom Sorts",
-                "isOptional": true,
-                "defaultValue": "[]"
+                "isOptional": true
             }
         ]
     },
@@ -5055,12 +5117,6 @@ exports.ADAPTABLE_METAMODEL = {
         "kind": "Interface",
         "description": "General-purpose context type, as defined by [FDC3](https://fdc3.finos.org/docs/1.0/context-intro). A context object is a well-understood datum that is streamable between FDC3 participants. As a result it has a field describing what type it is, and data indicating its identity. Use this as a base to derive your own with any custom properties or metadata.",
         "properties": [
-            {
-                "name": "(indexer)",
-                "kind": "indexType",
-                "description": "Custom properties and metadata. This can be extended in specific context object.",
-                "uiLabel": "(indexer)"
-            },
             {
                 "name": "id",
                 "kind": "unknown",
@@ -5417,7 +5473,7 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "useAgGridFilterFormStyle",
                 "kind": "boolean",
-                "description": "Styles Adaptable Filter Form to match AG Grid's current styling",
+                "description": "Styles Adaptable Filter Form to match AG Grid's styling (if using Balham theme)",
                 "uiLabel": "Use Ag Grid Filter Form Style",
                 "isOptional": true,
                 "gridInfo": "item",
@@ -5433,9 +5489,10 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "suppressFilterSearchBar",
                 "kind": "boolean",
-                "description": "Prevents AdapTable from filtering the list of values client-side; When true, values is called each time the search bar is changed   false",
+                "description": "Prevents AdapTable from filtering the list of values client-side; When true, values is called each time the search bar is changed",
                 "uiLabel": "Suppress Filter Search Bar",
-                "isOptional": true
+                "isOptional": true,
+                "defaultValue": "false"
             }
         ]
     },
@@ -5730,8 +5787,7 @@ exports.ADAPTABLE_METAMODEL = {
                 "kind": "unknown",
                 "description": "Flashing Cell Definitions - will colour cells/rows when rule is met",
                 "uiLabel": "Flashing Cell Definitions",
-                "isOptional": true,
-                "defaultValue": "null"
+                "isOptional": true
             }
         ]
     },
@@ -6018,7 +6074,6 @@ exports.ADAPTABLE_METAMODEL = {
                 "kind": "unknown",
                 "description": "Whether Column is String, Number, Boolean or Date",
                 "uiLabel": "Data Type",
-                "isOptional": true,
                 "defaultValue": "'String'"
             },
             {
@@ -6089,12 +6144,6 @@ exports.ADAPTABLE_METAMODEL = {
                 "description": "Checks if a User Edit was in a Free Text Column",
                 "uiLabel": "Check Free Text Column For Data Change"
             },
-            {
-                "name": "createFreeTextColumn",
-                "kind": "function",
-                "description": "Creates new FreeTextColumn and adds it to Adaptable State",
-                "uiLabel": "Create Free Text Column"
-            },
             {
                 "name": "deleteFreeTextColumn",
                 "kind": "function",
@@ -7074,9 +7123,15 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "dataRows",
                 "kind": "unknown",
-                "description": "Rows that have been added, updated, or deleted",
+                "description": "Data rows that have been added, updated, or deleted",
                 "uiLabel": "Data Rows"
             },
+            {
+                "name": "rowNodes",
+                "kind": "unknown",
+                "description": "AG Grid Row Nodes that were affected by the Change",
+                "uiLabel": "Row Nodes"
+            },
             {
                 "name": "rowTrigger",
                 "kind": "unknown",
@@ -7203,19 +7258,19 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "id",
                 "kind": "unknown",
-                "description": "The instrument data. Can contain some or all of: * `ticker`: a ticker * `ISIN`: [ISIN](https://www.isin.org/isin/) * `CUSIP`: [CUSIP](https://www.cusip.com/cusip/index.htm) * `SEDOL`: [SEDOL](https://www.londonstockexchange.com/products-and-services/reference-data/sedol-master-file/sedol-master-file.htm) * `RIC`: [Reuters Instrument Code (RIC)](https://en.wikipedia.org/wiki/Reuters_Instrument_Code) * `BBG`: [Bloomberg Ticker](https://www.bloomberg.com/professional/product/market-data/) * `PERMID`: [PERMID](https://permid.org/) * `FIGI`: [FIGI](https://www.openfigi.com/about/figi)",
+                "description": "The instrument data",
                 "uiLabel": "Id"
             },
             {
                 "name": "name",
                 "kind": "string",
-                "description": "Free text name of the instrument.",
+                "description": "Free text name of instrument",
                 "uiLabel": "Name"
             },
             {
                 "name": "type",
                 "kind": "unknown",
-                "description": "The context type is always 'instrument'.",
+                "description": "Context type is always 'instrument'",
                 "uiLabel": "Type"
             }
         ]
@@ -7756,6 +7811,12 @@ exports.ADAPTABLE_METAMODEL = {
                 "description": "Whether this Layout should be auto saved (based on Layout State and Layout Options)",
                 "uiLabel": "Should Auto Save Layout"
             },
+            {
+                "name": "showChangeColumnCaption",
+                "kind": "function",
+                "description": "Opens change column caption popup",
+                "uiLabel": "Show Change Column Caption"
+            },
             {
                 "name": "showLayoutPopup",
                 "kind": "function",
@@ -7853,16 +7914,14 @@ exports.ADAPTABLE_METAMODEL = {
                 "kind": "string",
                 "description": "Layout which will be loaded when AdapTable starts - must match `Name` property in Layout",
                 "uiLabel": "Current Layout",
-                "isOptional": true,
-                "defaultValue": "''"
+                "isOptional": true
             },
             {
                 "name": "Layouts",
                 "kind": "unknown",
                 "description": "Collection of Layout objects - listed in Layout toolbar and Tool Panel",
                 "uiLabel": "Layouts",
-                "isOptional": true,
-                "defaultValue": "null"
+                "isOptional": true
             }
         ]
     },
@@ -8005,38 +8064,8 @@ exports.ADAPTABLE_METAMODEL = {
     "NotificationsOptions": {
         "name": "NotificationsOptions",
         "kind": "Interface",
-        "description": "Options related to Alerts, System Status Messages and Notifications in Adaptable.",
+        "description": "Options related to System Status Messages and Notifications in Adaptable.",
         "properties": [
-            {
-                "name": "actionHandlers",
-                "kind": "unknown",
-                "description": "onClick Handlers for Alert Buttons (defined in Alert State)",
-                "uiLabel": "Action Handlers",
-                "isOptional": true
-            },
-            {
-                "name": "alertForms",
-                "kind": "unknown",
-                "description": "Full definitions of Alert Forms - the names of which are provided in Alert State",
-                "uiLabel": "Alert Forms",
-                "isOptional": true
-            },
-            {
-                "name": "alertMessageText",
-                "kind": "unknown",
-                "description": "Function providing Message to display in Alert; if empty, AdapTable provides dynamically",
-                "uiLabel": "Alert Message Text",
-                "isOptional": true
-            },
-            {
-                "name": "cellHighlightDuration",
-                "kind": "number",
-                "description": "How long (in ms) a cell will be highlighted",
-                "uiLabel": "Cell Highlight Duration",
-                "isOptional": true,
-                "gridInfo": "item",
-                "defaultValue": "3000"
-            },
             {
                 "name": "closeWhenClicked",
                 "kind": "boolean",
@@ -8046,15 +8075,6 @@ exports.ADAPTABLE_METAMODEL = {
                 "gridInfo": "item",
                 "defaultValue": "false"
             },
-            {
-                "name": "dataChangeDetectionPolicy",
-                "kind": "unknown",
-                "description": "Whether Alert rule is evaluated against the `rawValue` or `formattedValue` of the changed cell data",
-                "uiLabel": "Data Change Detection Policy",
-                "isOptional": true,
-                "gridInfo": "item",
-                "defaultValue": "'rawValue'"
-            },
             {
                 "name": "duration",
                 "kind": "unknown",
@@ -8073,15 +8093,6 @@ exports.ADAPTABLE_METAMODEL = {
                 "gridInfo": "item",
                 "defaultValue": "false"
             },
-            {
-                "name": "maxAlertsInStore",
-                "kind": "number",
-                "description": "How many alerts held in State at any one time; when limit is breached, oldest alert will be removed",
-                "uiLabel": "Max Alerts In Store",
-                "isOptional": true,
-                "gridInfo": "item",
-                "defaultValue": "20"
-            },
             {
                 "name": "maxNotifications",
                 "kind": "number",
@@ -8237,6 +8248,12 @@ exports.ADAPTABLE_METAMODEL = {
                 "description": "Clears any objects in internal OpenFin state created by AdapTable",
                 "uiLabel": "Clear Open Fin Internal State"
             },
+            {
+                "name": "getAlertOptions",
+                "kind": "function",
+                "description": "Gets the Alert section from Adaptable Options",
+                "uiLabel": "Get Alert Options"
+            },
             {
                 "name": "getCurrentLiveOpenFinReport",
                 "kind": "function",
@@ -8433,7 +8450,57 @@ exports.ADAPTABLE_METAMODEL = {
     "PluginsApi": {
         "name": "PluginsApi",
         "kind": "Interface",
-        "description": "API methods dealing with AdapTable plugins"
+        "description": "API methods dealing with AdapTable plugins",
+        "properties": [
+            {
+                "name": "getFinancePluginApi",
+                "kind": "function",
+                "description": "Returns Finance API class in Adaptable API",
+                "uiLabel": "Get Finance Plugin Api"
+            },
+            {
+                "name": "getGlue42PluginApi",
+                "kind": "function",
+                "description": "Returns Glue42 API class in Adaptable API",
+                "uiLabel": "Get Glue42Plugin Api"
+            },
+            {
+                "name": "getipushpullPluginApi",
+                "kind": "function",
+                "description": "Returns ipushpull API class in Adaptable API",
+                "uiLabel": "Getipushpull Plugin Api"
+            },
+            {
+                "name": "getOpenFinPluginApi",
+                "kind": "function",
+                "description": "Returns OpenFin API class in Adaptable API",
+                "uiLabel": "Get Open Fin Plugin Api"
+            },
+            {
+                "name": "getPluginsState",
+                "kind": "function",
+                "description": "Retrieves the Plugin State (internal only)",
+                "uiLabel": "Get Plugins State"
+            },
+            {
+                "name": "getPluginState",
+                "kind": "function",
+                "description": "Gets the State for a given Plugin",
+                "uiLabel": "Get Plugin State"
+            },
+            {
+                "name": "registerPlugin",
+                "kind": "function",
+                "description": "Registers a Plugin (internal method)",
+                "uiLabel": "Register Plugin"
+            },
+            {
+                "name": "setPluginState",
+                "kind": "function",
+                "description": "Sets the initial state for a given plugin (internal method)",
+                "uiLabel": "Set Plugin State"
+            }
+        ]
     },
     "PlusMinusApi": {
         "name": "PlusMinusApi",
@@ -8564,7 +8631,7 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "Alert",
                 "kind": "REFERENCE",
-                "description": "Supplies a collection of *Alert Definition* objects which will fire when their definition is triggered, and where Alerts are displayed",
+                "description": "Collection of `AlertDefinitions` which will fire Alerts when the rule is met",
                 "uiLabel": "Alert",
                 "isOptional": true,
                 "reference": "AlertState"
@@ -8633,6 +8700,14 @@ exports.ADAPTABLE_METAMODEL = {
                 "isOptional": true,
                 "reference": "FilterState"
             },
+            {
+                "name": "FlashingCell",
+                "kind": "REFERENCE",
+                "description": "* Objects which define which cells flash in response to data changes",
+                "uiLabel": "Flashing Cell",
+                "isOptional": true,
+                "reference": "FlashingCellState"
+            },
             {
                 "name": "FormatColumn",
                 "kind": "REFERENCE",
@@ -10328,7 +10403,7 @@ exports.ADAPTABLE_METAMODEL = {
     "SystemStatusMessageDisplayedInfo": {
         "name": "SystemStatusMessageDisplayedInfo",
         "kind": "Interface",
-        "description": "Object returned by the SystemStatusMessageDisplayed' event",
+        "description": "Object returned by the `SystemStatusMessageDisplayed` event",
         "properties": [
             {
                 "name": "systemStatusMessageInfo",
@@ -10452,14 +10527,14 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "getSharedEntities",
                 "kind": "unknown",
-                "description": "Function which retrieves available Shared Entities that user can download and merge automatically with Adaptable State",
+                "description": "Async function which retrieves available Shared Entities that user can download and merge automatically with Adaptable State",
                 "uiLabel": "Get Shared Entities",
                 "defaultValue": "null"
             },
             {
                 "name": "setSharedEntities",
                 "kind": "unknown",
-                "description": "Function which uploads Shared Entities so they can be downloaded by other members of the team",
+                "description": "Async function which uploads Shared Entities so they can be downloaded by other members of the team",
                 "uiLabel": "Set Shared Entities",
                 "defaultValue": "null"
             },
@@ -10851,6 +10926,12 @@ exports.ADAPTABLE_METAMODEL = {
                 "description": "Retrieves `permittedValues` property from User Interface Options",
                 "uiLabel": "Get All Permitted Values Items"
             },
+            {
+                "name": "getBulkUpdatePermittedValuesForColumn",
+                "kind": "function",
+                "description": "Retrieves Permitted values for Bulk Update Module",
+                "uiLabel": "Get Bulk Update Permitted Values For Column"
+            },
             {
                 "name": "getColorPalette",
                 "kind": "function",
@@ -10860,7 +10941,7 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "getCustomSortPermittedValuesForColumn",
                 "kind": "function",
-                "description": "Retrieves Permitted values for Custom sort.",
+                "description": "Retrieves Permitted values for Custom Sort Module",
                 "uiLabel": "Get Custom Sort Permitted Values For Column"
             },
             {
@@ -10884,7 +10965,7 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "getFilterPermittedValuesForColumn",
                 "kind": "function",
-                "description": "Retrieves Permitted values for filtering by column values in Floating Filter and dropdown Filter.",
+                "description": "Retrieves Permitted values for filtering by column values in Floating Filter and Quick Filter Bar",
                 "uiLabel": "Get Filter Permitted Values For Column"
             },
             {

package/src/types.d.ts

@@ -4,7 +4,8 @@ export type { AdaptableOptions } from './AdaptableOptions/AdaptableOptions';
 export { AdaptablePlugin } from './AdaptableOptions/AdaptablePlugin';
 export type { ContainerOptions } from './AdaptableOptions/ContainerOptions';
 export type { FlashingCellOptions } from './AdaptableOptions/FlashingCellOptions';
-export type { ActionHandler, AlertForm, AlertButtonContext, NotificationsOptions, } from './AdaptableOptions/NotificationsOptions';
+export type { NotificationsOptions } from './AdaptableOptions/NotificationsOptions';
+export type { AlertOptions, ActionHandler, AlertForm, AlertButtonContext, } from './AdaptableOptions/AlertOptions';
 export type { DashboardOptions, CustomToolbar, DashboardButtonContext, CustomToolbarButtonContext, } from './AdaptableOptions/DashboardOptions';
 export type { EditOptions, ValidationResult } from './AdaptableOptions/EditOptions';
 export type { ExportOptions, SystemExportDestination, SystemExportDestinations, CustomDestination, CustomReport, DataFormatType, ExportButtonContext, } from './AdaptableOptions/ExportOptions';

package/themes/dark.css

@@ -3,14 +3,14 @@ html.ab--theme-dark {
   --ab-theme-loaded: dark;
   --ab-cmp-input--disabled__background: #232323;
   --ab-color-defaultbackground: #3e444c;
-  --ab-color-text-on-defaultbackground:  #E2E2E2;
+  --ab-color-text-on-defaultbackground: #e2e2e2;
   --ab-color-primary: #262d2f;
   --ab-color-primarylight: #2d3537;
   --ab-color-primarydark: #1c2021;
-  --ab-color-text-on-primary: #E2E2E2  ;
+  --ab-color-text-on-primary: #e2e2e2;
   --ab-dashboard__border: #555;
   --ab-cmp-dropdownbutton-list-separator__border: 1px solid #555;
   --ab-gridheader--filtered__background: var(--ab-color-defaultbackground); }
-  html.ab--theme-dark input[type="number"].ab-Input::-webkit-outer-spin-button,
-  html.ab--theme-dark input[type="number"].ab-Input::-webkit-inner-spin-button {
+  html.ab--theme-dark input[type='number'].ab-Input::-webkit-outer-spin-button,
+  html.ab--theme-dark input[type='number'].ab-Input::-webkit-inner-spin-button {
     background: url('data:image/svg+xml;utf8,<svg xmlns="http://www.w3.org/2000/svg" width="18" height="20" viewBox="4 0 18 18" version="1.1"><path fill="%23f7f7f7" d="M7 10l5 5 5-5z" transform="translate(0, 2)"/><path fill="%23f7f7f7" d="M7 14l5-5 5 5z" transform="translate(0, -6)"/></svg>') no-repeat center center; }

package/version.d.ts

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

package/version.js

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