@adaptabletools/adaptable 10.0.0-canary.0

package/src/PredefinedConfig/Common/FDC3Context.d.ts

@@ -0,0 +1,65 @@
+/**
+ * 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.
+ */
+export interface FDC3Context {
+    /**
+     * The type of the context that uniquely identifies it, e.g. "instrument".
+     * This is used to refer to the accepted context(s) when declaring intents. See [[AppDirIntent]].
+     */
+    type: string;
+    /**
+     * The name of the context data (optional). This is a text string that describes the data being sent.
+     * Implementors of context may choose to make the name mandatory.
+     */
+    name?: string;
+    /**
+     * An optional map of any equivalent identifiers for the context type, e.g. ISIN, CUSIP, etc. for an instrument.
+     */
+    id?: {
+        [key: string]: string | undefined;
+    };
+    /**
+     * @hidden
+     * Custom properties and metadata. This can be extended in specific context object.
+     */
+    [key: string]: unknown;
+}
+/**
+ * Built-in context to define a financial instrument.
+ */
+export interface InstrumentContext extends FDC3Context {
+    /**
+     * The context type is always 'instrument'.
+     */
+    type: 'instrument';
+    /**
+     * Free text name of the instrument.
+     */
+    name: string;
+    /**
+     * 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)
+     */
+    id: {
+        [key: string]: string;
+    } & {
+        ticker?: string;
+        ISIN?: string;
+        CUSIP?: string;
+        SEDOL?: string;
+        RIC?: string;
+        BBG?: string;
+        PERMID?: string;
+        FIGI?: string;
+    };
+}

package/src/PredefinedConfig/Common/FDC3Context.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/PredefinedConfig/Common/FilterActionOnDataChange.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Determines whether Adaptable should re-apply filtering after cell and ticking data edits. *
+ * If the 'applyFilter' value is 'Throttle' then the 'throttleDelay' property should be additionally set.
+ */
+export interface FilterActionOnDataChange {
+    /**
+     * When to re-apply Filters: 'Always', 'Never' or 'Throttle'
+     */
+    applyFilter: 'Always' | 'Never' | 'Throttle';
+    /**
+     * Delay in ms (when `applyFilter` is set to 'Throttle')
+     */
+    throttleDelay?: number;
+}

package/src/PredefinedConfig/Common/FilterActionOnDataChange.js

@@ -0,0 +1,6 @@
+"use strict";
+/**
+ * Determines whether Adaptable should re-apply filtering after cell and ticking data edits. *
+ * If the 'applyFilter' value is 'Throttle' then the 'throttleDelay' property should be additionally set.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/PredefinedConfig/Common/Menu.d.ts

@@ -0,0 +1,123 @@
+import * as Redux from 'redux';
+import { GridCell } from '../Selection/GridCell';
+import { AdaptableColumn } from './AdaptableColumn';
+import { AdaptableModule } from './Types';
+import { AdaptableApi } from '../../Api/AdaptableApi';
+import { SelectedCellInfo } from '../Selection/SelectedCellInfo';
+import { SelectedRowInfo } from '../Selection/SelectedRowInfo';
+import { Column, RowNode } from '@ag-grid-community/all-modules';
+/**
+ * Menu item used by Adaptable in 3 places: Module Menu (at left of Dashboard Header), Column Header Menu and Context Menu
+ */
+export interface AdaptableMenuItem {
+    /**
+     * Name that appears in the menu
+     */
+    label: string;
+    /**
+     * Adaptable Module associated with (shipped) menu item.
+     */
+    module?: AdaptableModule | 'General';
+    /**
+     * Adaptable Redux Action to invoke when (shipped) menu item is clicked
+     */
+    reduxAction?: Redux.Action;
+    /**
+     * Function to invoice when (custom) menu item is clicked
+     */
+    onClick?: () => void;
+    /**
+     * Whether menu item is visible
+     */
+    isVisible: boolean;
+    /**
+     * Icon to display in Menu Item
+     */
+    icon?: string;
+    /**
+     * Sub Menu Items to display
+     */
+    subItems?: AdaptableMenuItem[];
+}
+/**
+ * Defines a Menu Item created at design-time, can be added to Column Header or Context Menu, and can contain sub items.
+ */
+export interface UserMenuItem {
+    /**
+     * The text that will appear in the Menu Item
+     */
+    label: string | ((menuContext: MenuContext) => string);
+    /**
+     * Function to invoke when the Menu Item is clicked
+     */
+    onClick?: (menuContext: MenuContext) => void;
+    /**
+     * Function to evaluate whether Menu Item is visible
+     */
+    hidden?: (menuContext: MenuContext) => boolean;
+    /**
+     * Function to evaluate whether Menu Item is enabled
+     */
+    disabled?: (menuContext: MenuContext) => boolean;
+    /**
+     * Optional icon to show in the Menu Item
+     */
+    icon?: string;
+    /**
+     * Array of Menu Items, enabling creation of (limitless levels of) sub menus
+     */
+    subMenuItems?: UserMenuItem[];
+}
+/**
+ * Provides full details about current Menu; used for both Column and Context Menus
+ */
+export interface MenuContext {
+    /**
+     *  Cell that has been clicked; contains cell value
+     */
+    gridCell: GridCell;
+    /**
+     * Current Adaptable Column
+     */
+    adaptableColumn: AdaptableColumn;
+    /**
+     * Current Vendor Grid Column
+     */
+    vendorColumn: Column;
+    /**
+     * Whether cell that was clicked is also currently selected
+     */
+    isSelectedCell: boolean;
+    /**
+     * Whether Column that was clicked is only column with selected cells
+     */
+    isSingleSelectedColumn: boolean;
+    /**
+     * Current AG Grid row node
+     */
+    rowNode: RowNode;
+    /**
+     * Whether current row node is grouped
+     */
+    isGroupedNode: boolean;
+    /**
+     * Whether current Column is Row Group
+     */
+    isRowGroupColumn: boolean;
+    /**
+     * Value of Primary Key column in current row
+     */
+    primaryKeyValue: any;
+    /**
+     * The Adaptable Api - included as a convenience
+     */
+    adaptableApi: AdaptableApi;
+    /**
+     * Currently selected cells in the grid
+     */
+    selectedCellInfo: SelectedCellInfo;
+    /**
+     * Currently selected rows in the grid
+     */
+    selectedRowInfo: SelectedRowInfo;
+}

package/src/PredefinedConfig/Common/Menu.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/PredefinedConfig/Common/Schedule.d.ts

@@ -0,0 +1,48 @@
+import { AdaptableObject } from './AdaptableObject';
+import { SuspendableObject } from './SuspendableObject';
+/**
+ * Defines when an action will be run - either one-off or recurring
+ */
+export interface Schedule extends AdaptableObject {
+    /**
+     * Hour the Schedule will run
+     */
+    Hour: number;
+    /**
+     * Minute the Schedule will run
+     */
+    Minute: number;
+    /**
+     * A one off date on which the Schedule will run
+     */
+    OneOffDate?: string;
+    /**
+     * Days on which Shedule will run
+     */
+    DaysOfWeek?: DayOfWeek[];
+}
+/**
+ * Base Schedule object - typically overriden by Functions
+ */
+export interface BaseSchedule extends SuspendableObject {
+    /**
+     * The Schedule to run
+     */
+    Schedule: Schedule;
+    /**
+     * The type of Schedule
+     */
+    ScheduleType: 'Report' | 'ipushpull' | 'Glue42' | 'Reminder' | 'OpenFin';
+}
+/**
+ * Enum listing Days of the Week by 0-based index
+ */
+export declare enum DayOfWeek {
+    Sunday = 0,
+    Monday = 1,
+    Tuesday = 2,
+    Wednesday = 3,
+    Thursday = 4,
+    Friday = 5,
+    Saturday = 6
+}

package/src/PredefinedConfig/Common/Schedule.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DayOfWeek = void 0;
+/**
+ * Enum listing Days of the Week by 0-based index
+ */
+var DayOfWeek;
+(function (DayOfWeek) {
+    DayOfWeek[DayOfWeek["Sunday"] = 0] = "Sunday";
+    DayOfWeek[DayOfWeek["Monday"] = 1] = "Monday";
+    DayOfWeek[DayOfWeek["Tuesday"] = 2] = "Tuesday";
+    DayOfWeek[DayOfWeek["Wednesday"] = 3] = "Wednesday";
+    DayOfWeek[DayOfWeek["Thursday"] = 4] = "Thursday";
+    DayOfWeek[DayOfWeek["Friday"] = 5] = "Friday";
+    DayOfWeek[DayOfWeek["Saturday"] = 6] = "Saturday";
+})(DayOfWeek = exports.DayOfWeek || (exports.DayOfWeek = {}));

package/src/PredefinedConfig/Common/SuspendableObject.d.ts

@@ -0,0 +1,10 @@
+import { AdaptableObject } from './AdaptableObject';
+/**
+ * Interface that extends Adaptable Object for those config items that can be suspended at run-time
+ */
+export interface SuspendableObject extends AdaptableObject {
+    /**
+     * Suspends (i.e. turns off) an Adaptable Object
+     */
+    IsSuspended?: boolean;
+}

package/src/PredefinedConfig/Common/SuspendableObject.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/PredefinedConfig/Common/SystemStatusMessageInfo.d.ts

@@ -0,0 +1,23 @@
+import { AdaptableMessageType } from './AdaptableMessageType';
+import { AdaptableObject } from '../../types';
+/**
+ * Wraps a System Status Message
+ */
+export interface SystemStatusMessageInfo extends AdaptableObject {
+    /**
+     * The Message to be displayed
+     */
+    statusMessage: string;
+    /**
+     * Additional information to display (optional)
+     */
+    statusFurtherInformation?: string;
+    /**
+     * Type of Message i.e. Succcess, Warning, Error, Info
+     */
+    statusType: AdaptableMessageType;
+    /**
+     * When Message was sent
+     */
+    timestamp?: Date;
+}

package/src/PredefinedConfig/Common/SystemStatusMessageInfo.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/PredefinedConfig/Common/Types.d.ts

@@ -0,0 +1,27 @@
+/**
+ * Adaptable Toolbar collection.  When setting `Toolbars` in Dashboard state, only those listed here can be included
+ */
+export declare type AdaptableDashboardToolbars = AdaptableDashboardToolbar[];
+/**
+ * List of all the Toolbars that Adaptable provides
+ */
+export declare type AdaptableDashboardToolbar = 'Query' | 'Alert' | 'BulkUpdate' | 'CellSummary' | 'Chart' | 'Filter' | 'DataSource' | 'Export' | 'Glue42' | 'OpenFin' | 'IPushPull' | 'Layout' | 'QuickSearch' | 'SmartEdit' | 'SystemStatus' | 'Theme';
+export declare type AdaptableToolPanels = AdaptableToolPanel[];
+export declare type AdaptableToolPanel = 'Alert' | 'BulkUpdate' | 'CellSummary' | 'Chart' | 'Filter' | 'Dashboard' | 'Export' | 'IPushPull' | 'OpenFin' | 'Layout' | 'Query' | 'QuickSearch' | 'SmartEdit' | 'SystemStatus' | 'Theme';
+export declare const ALL_TOOL_PANELS: AdaptableToolPanels;
+/**
+ * Adaptable Module Button collection
+ *
+ * When setting the `ModuleButtons` property in Dashboard state, only the Module Buttons listed here can be included.
+ */
+export declare type AdaptableModuleButtons = AdaptableModuleButton[];
+/**
+ * List of all the Module buttons Adaptable provides - each Module has a popup for which this is a shortcut button
+ */
+export declare type AdaptableModuleButton = 'Query' | 'Alert' | 'BulkUpdate' | 'CalculatedColumn' | 'CellSummary' | 'Chart' | 'Filter' | 'ConditionalStyle' | 'CustomSort' | 'Dashboard' | 'DataSource' | 'Export' | 'FormatColumn' | 'FreeTextColumn' | 'Glue42' | 'GridInfo' | 'Layout' | 'OpenFin' | 'PlusMinus' | 'QuickSearch' | 'Schedule' | 'Shortcut' | 'SmartEdit' | 'SparklineColumn' | 'StateManagement' | 'SystemStatus' | 'TeamSharing' | 'Theme';
+export declare type AdaptableStateKeys = AdaptableStateKey[];
+export declare type AdaptableStateKey = 'Query' | 'Alert' | 'Application' | 'BulkUpdate' | 'CalculatedColumn' | 'CellSummary' | 'Chart' | 'ConditionalStyle' | 'CustomSort' | 'Dashboard' | 'DataSource' | 'Entitlement' | 'Export' | 'FormatColumn' | 'FreeTextColumn' | 'Glue42' | 'IPushPull' | 'Layout' | 'OpenFin' | 'PlusMinus' | 'QuickSearch' | 'Schedule' | 'Shortcut' | 'SmartEdit' | 'SparklineColumn' | 'Filter' | 'SystemStatus' | 'Theme' | 'ToolPanel' | 'UserInterface';
+export declare type AdaptableModule = 'Alert' | 'BulkUpdate' | 'CalculatedColumn' | 'CellSummary' | 'Chart' | 'Filter' | 'ConditionalStyle' | 'CustomSort' | 'Dashboard' | 'DataSource' | 'Export' | 'FormatColumn' | 'FreeTextColumn' | 'Glue42' | 'GridInfo' | 'IPushPull' | 'Layout' | 'OpenFin' | 'PlusMinus' | 'Query' | 'QuickSearch' | 'Schedule' | 'Shortcut' | 'SmartEdit' | 'SparklineColumn' | 'StateManagement' | 'SystemStatus' | 'TeamSharing' | 'Theme' | 'ToolPanel' | 'ChangeHistory';
+export declare type TypeHint<Base, Literals> = (Base & {
+    __subType?: true;
+}) | Literals;

package/src/PredefinedConfig/Common/Types.js

@@ -0,0 +1,23 @@
+"use strict";
+/*
+This page includes frequently used typed - particularly helpful for State and Api where we can strongly type stuff
+*/
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ALL_TOOL_PANELS = void 0;
+exports.ALL_TOOL_PANELS = [
+    'Alert',
+    'BulkUpdate',
+    'CellSummary',
+    'Chart',
+    'Filter',
+    'Dashboard',
+    'Export',
+    'IPushPull',
+    'OpenFin',
+    'Layout',
+    'Query',
+    'QuickSearch',
+    'SmartEdit',
+    'SystemStatus',
+    'Theme',
+];

package/src/PredefinedConfig/ConditionalStyleState.d.ts

@@ -0,0 +1,50 @@
+import { ConfigState } from './ConfigState';
+import { AdaptableStyle } from './Common/AdaptableStyle';
+import { AdaptableScope } from './Common/AdaptableScope';
+import { AdaptablePredicate } from './Common/AdaptablePredicate';
+import { TypeHint } from './Common/Types';
+import { XOR } from '../Utilities/Extensions/TypeExtensions';
+import { AdaptableBooleanQuery } from './Common/AdaptableQuery';
+import { SuspendableObject } from './Common/SuspendableObject';
+/**
+ * Predefined Configuration for the Conditional Style function
+ **/
+export interface ConditionalStyleState extends ConfigState {
+    /**
+     * Array of Conditional Styles to ship with Adaptable
+     */
+    ConditionalStyles?: ConditionalStyle[];
+}
+/**
+ * Object used in Conditional Style function - contains Scope, a Rule and a Style
+ */
+export interface ConditionalStyle extends SuspendableObject {
+    /**
+     * Where Style is applied - can be whole Row, some Columns or all Columns of given DataType
+     */
+    Scope: AdaptableScope;
+    /**
+     * Predicate-based Rule to use for deciding if a style needs to be applied.
+     */
+    Rule: ConditionalStyleRule;
+    /**
+     * Adaptable Style (e.g. font properties and colurs) to apply.
+     */
+    Style: AdaptableStyle;
+    /**
+     * Whether to apply Style in Grouped Rows
+     * @defaultValue false
+     */
+    IncludeGroupedRows?: boolean;
+}
+export interface ConditionalStylePredicate extends AdaptablePredicate {
+    PredicateId: TypeHint<string, SystemConditionalStylePredicateId>;
+}
+/**
+ * The Conditional Style Rule - can be either a Predicate or an Expression
+ */
+export declare type ConditionalStyleRule = XOR<{
+    Predicate: ConditionalStylePredicate;
+}, AdaptableBooleanQuery>;
+declare type SystemConditionalStylePredicateId = 'Blanks' | 'NonBlanks' | 'Equals' | 'NotEquals' | 'GreaterThan' | 'LessThan' | 'Positive' | 'Negative' | 'Zero' | 'Between' | 'NotBetween' | 'Is' | 'IsNot' | 'Contains' | 'NotContains' | 'StartsWith' | 'EndsWith' | 'Regex' | 'Today' | 'Yesterday' | 'Tomorrow' | 'ThisWeek' | 'ThisMonth' | 'ThisQuarter' | 'ThisYear' | 'InPast' | 'InFuture' | 'Before' | 'After' | 'On' | 'NotOn' | 'NextWorkDay' | 'LastWorkDay' | 'True' | 'False';
+export {};

package/src/PredefinedConfig/ConditionalStyleState.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/PredefinedConfig/ConfigState.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Base Interface for all Adaptable State objects; contains`Revision` property, used for versioning
+ */
+export interface ConfigState {
+    /**
+     * Version number of the Item - allows developers to update one section in Predefined Config while keeping others unchanged
+     */
+    Revision?: number;
+}

package/src/PredefinedConfig/ConfigState.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/PredefinedConfig/CustomSortState.d.ts

@@ -0,0 +1,26 @@
+import { ConfigState } from './ConfigState';
+import { SuspendableObject } from './Common/SuspendableObject';
+/**
+ * Predefined Configuration for Custom Sort function
+ */
+export interface CustomSortState extends ConfigState {
+    /**
+     * Collection of Custom Sort objects.
+     * @defaultValue []
+     */
+    CustomSorts?: CustomSort[];
+}
+/**
+ * Custom Sort object used in Custom Sort function.
+ */
+export interface CustomSort extends SuspendableObject {
+    /**
+     * Id of Column on which Custom Sort will be applied
+     */
+    ColumnId: string;
+    /**
+     * Order of values by which Column will be sorted; any Column values NOT in this list will be sorted alphabetically AFTER all list values have been sorted
+     *
+     */
+    SortedValues?: string[];
+}

package/src/PredefinedConfig/CustomSortState.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/PredefinedConfig/DashboardState.d.ts

@@ -0,0 +1,76 @@
+import { ConfigState } from './ConfigState';
+import { AdaptableDashboardToolbars, AdaptableModuleButtons } from './Common/Types';
+import { AdaptableObject } from './Common/AdaptableObject';
+/**
+ * Predefined Configuration for the AdapTable Dashboard
+ */
+export interface DashboardState extends ConfigState {
+    /**
+     * Named group of Toolbars - each Toolbar should only be in one Tab; if no Tabs are provided, AdapTable creates one named 'Toolbars'
+     */
+    Tabs?: DashboardTab[];
+    /**
+     * The index of the Active Tab (in Tabs collection)
+     */
+    ActiveTabIndex?: number;
+    /**
+     * Whether Dashboard is collapsed; if true, header is visible (but not tabs' contents)
+     *  @defaultValue false
+     */
+    IsCollapsed?: boolean;
+    /**
+     * Whether Dashboard is floating; if true, appears in draggable, minmised form (double-click to revert to default position)
+     *  @defaultValue false
+     */
+    IsFloating?: boolean;
+    /**
+     * Alternative way of showing Expanded Dashboard where headers section is to left of Toolbars
+     * @defaultValue false
+     */
+    IsInline?: boolean;
+    /**
+     * Whether Dashboard is completely hidden - can be made visible again in Column menu and toolpanel
+     * @defaultValue false
+     */
+    IsHidden?: boolean;
+    /**
+     * Position of Dashboard in 'floating mode' - set and stored by AdapTable
+     */
+    FloatingPosition?: AdaptableCoordinate;
+    /**
+     * Module Buttons visible in Dasbhoard Header when application loads - open popup screen for associated AdapTable Module
+     * @defaultValue ['SystemStatus', 'GridInfo', 'Layout' 'ConditionalStyle']
+     */
+    ModuleButtons?: AdaptableModuleButtons;
+    /**
+     * Title to display in Dashboard Header; if missing, 'adaptableId' property in Adaptable Options is used
+     * @defaultValue `adaptableId` in Adaptable Options
+     */
+    DashboardTitle?: string;
+}
+/**
+ * Defines a named set of Toolbars in the AdapTable Dashboard
+ */
+export interface DashboardTab extends AdaptableObject {
+    /**
+     * Name of the tab - as appears in the Dashboard
+     */
+    Name: string;
+    /**
+     * List of Toolbars to show in the Tab
+     */
+    Toolbars: AdaptableDashboardToolbars | string[];
+}
+/**
+ * Used by AdapTable to remember position of Floating Dashboard
+ */
+export interface AdaptableCoordinate extends AdaptableObject {
+    /**
+     * x axis number
+     */
+    x: number;
+    /**
+     * y axis number
+     */
+    y: number;
+}

package/src/PredefinedConfig/DashboardState.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/PredefinedConfig/DataSourceState.d.ts

@@ -0,0 +1,34 @@
+import { ConfigState } from './ConfigState';
+import { AdaptableObject } from './Common/AdaptableObject';
+import { AdaptableForm } from './Common/AdaptableForm';
+import { ButtonContext } from './Common/AdaptableButton';
+/**
+ * Predefined Configuration for Data Source function
+ */
+export interface DataSourceState extends ConfigState {
+    /**
+     * Collection of available Data Sources
+     */
+    DataSources?: DataSource[];
+    /**
+     * Name of the currently selected Data Source
+     */
+    CurrentDataSource?: string;
+}
+/**
+ * Defines a Data Source object - used in Data Source function
+ */
+export interface DataSource extends AdaptableObject {
+    /**
+     * Name of Data Source
+     */
+    Name: string;
+    /**
+     * Describes the Data Source
+     */
+    Description: string;
+    /**
+     * Params for DataSource pops up a form
+     */
+    Form?: AdaptableForm<ButtonContext>;
+}

package/src/PredefinedConfig/DataSourceState.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });