@adaptabletools/adaptable 10.0.0-canary.0

package/src/AdaptableOptions/StateOptions.d.ts

@@ -0,0 +1,79 @@
+import { AdaptableState } from '../PredefinedConfig/AdaptableState';
+/**
+ * Options related to state hydration/dehydration - allows users to intercept state persistence and state loading with custom functionality.
+ */
+export interface StateOptions {
+    /**
+     * Allows the customization of state persistence.
+     */
+    persistState?: AdaptablePersistStateFunction;
+    /**
+     * Allows the customization of state loading.
+     */
+    loadState?: AdaptableLoadStateFunction;
+    /**
+     * Allows the customization of the state that is going to be persisted
+     */
+    saveState?: AdaptableSaveStateFunction;
+    /**
+     * Allows hooking into AdaptableState hydration
+     */
+    applyState?: (state: any) => any;
+    /**
+     * Allows clearing of remote state.
+     */
+    clearState?: AdaptableClearStateFunction;
+    /**
+     * Delay (in ms) to debounce saveState/persistState calls enabling grouping multiple sequential calls in single one (e.g. elevator doors)
+     *
+     * **Defaults to: 400**. Also, the wait will be max 1000ms, at which point the save/persist calls will happen anyway.
+     *
+     * @defaultValue 400
+     */
+    debounceStateDelay?: number;
+}
+export declare type AdaptableStateFunctionConfig = {
+    adaptableId: string;
+    adaptableStateKey: string;
+    userName: string;
+    url?: string;
+};
+/**
+ * Allows the customization of state persistence.
+ *
+ * Used by the `persistState` function property in StateOptions
+ *
+ * @example
+ *
+ * persistState = (state, {adaptableId, adaptableStateKey}) => {
+ *  localStorage.setItem(adaptableStateKey, JSON.stringify(state))
+ * }
+ */
+export interface AdaptablePersistStateFunction {
+    (state: any, { adaptableId, adaptableStateKey, userName, url }: AdaptableStateFunctionConfig): Promise<any>;
+}
+/**
+ * Allows clearing state when a custom persistState is used.
+ * Only called by configApi.reloadPredefinedConfig
+ *
+ * @example
+ */
+export interface AdaptableClearStateFunction {
+    ({ adaptableId, adaptableStateKey, userName, url }: AdaptableStateFunctionConfig): Promise<any>;
+}
+/**
+ * Allows the customization of state persistence.
+ *
+ * Used by the `saveState` function property in StateOptions
+ */
+export interface AdaptableSaveStateFunction {
+    (state: AdaptableState, { adaptableId, adaptableStateKey, userName, url }: AdaptableStateFunctionConfig): any;
+}
+/**
+ * Allows the customization of state loading.
+ *
+ * Userd by the `loadState` function property in StateOptions
+ */
+export interface AdaptableLoadStateFunction {
+    (config: AdaptableStateFunctionConfig): Promise<any>;
+}

package/src/AdaptableOptions/StateOptions.js

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

package/src/AdaptableOptions/SystemStatusOptions.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Options related to System Status Module in Adaptable.
+ */
+export interface SystemStatusOptions {
+    /**
+     * Display an Alert when a System Status message is set
+     *
+     * @defaultValue false
+     * @gridInfoItem
+     */
+    showMessageAsAlert?: boolean;
+    /**
+     * How many System Status Messages to hold in State; when limit is reached, oldest Message is removed
+     *
+     * @defaultValue  100
+     * @gridInfoItem
+     */
+    maxMessagesInStore?: number;
+}

package/src/AdaptableOptions/SystemStatusOptions.js

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

package/src/AdaptableOptions/TeamSharingOptions.d.ts

@@ -0,0 +1,39 @@
+import { SharedEntity } from '../PredefinedConfig/TeamSharingState';
+/**
+ * Options for managing Team Sharing - which enables Adaptable Objects to be shared between colleagues
+ */
+export interface TeamSharingOptions {
+    /**
+     * Whether Team Sharing is enabled
+     *
+     * @defaultValue false
+     * @gridInfoItem
+     */
+    enableTeamSharing: boolean;
+    /**
+     * Function which retrieves available Shared Entities that user can download and merge automatically with Adaptable State
+     *
+     * @defaultValue null
+     */
+    getSharedEntities: (adaptableId: string) => Promise<SharedEntity[]>;
+    /**
+     * Function which uploads Shared Entities so they can be downloaded by other members of the team
+     *
+     * @defaultValue null
+     */
+    setSharedEntities: (adaptableId: string, sharedEntities: SharedEntity[]) => Promise<void>;
+    /**
+     * Frequency (in minutes) to check if Active Shared Entities have a newer revision
+     *
+     * @defaultValue 0 (never)
+     * @gridInfoItem
+     */
+    updateInterval?: number;
+    /**
+     * How user is informed when Active Shared Entities have newer revisions: can be 'Alert', 'AlertWithNotification' or 'SystemStatus'
+     *
+     * @defaultValue null (none)
+     * @gridInfoItem
+     */
+    updateNotification?: 'Alert' | 'AlertWithNotification' | 'SystemStatus';
+}

package/src/AdaptableOptions/TeamSharingOptions.js

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

package/src/AdaptableOptions/ToolPanelOptions.d.ts

@@ -0,0 +1,132 @@
+import { AdaptableObject } from '../PredefinedConfig/Common/AdaptableObject';
+import { AdaptableApi } from '../Api/AdaptableApi';
+import { AdaptableFrameworkComponent } from './AdaptableFrameworkComponent';
+import { AdaptableButton, ButtonContext } from '../PredefinedConfig/Common/AdaptableButton';
+import { ToolPanelState } from '../PredefinedConfig/ToolPanelState';
+/**
+ * Options related to managing the AdapTable ToolPanel Component
+ */
+export interface ToolPanelOptions {
+    /**
+     * Displays Adaptable ToolPanel Component (only if AG Grid Sidebar is provided)
+     *
+     * @defaultValue true
+     * @gridInfoItem
+     */
+    showAdaptableToolPanel?: boolean;
+    /**
+     * Title for AdapTable ToolPanel Component - appears vertically at side
+     *
+     * @defaultValue 'AdapTable'
+     * @gridInfoItem
+     */
+    adaptableToolPanelTitle?: string;
+    /**
+     * Key of icon to be used (beside the label) for Adaptable ToolPanel Component
+     *
+     * @defaultValue 'menu'
+     * @see https://www.ag-grid.com/javascript-grid/side-bar/#sidebardef-configuration
+     * @gridInfoItem
+     */
+    iconKey?: string;
+    /**
+     * The initial width of AdapTable ToolPanel
+     * @defaultValue var(--ab-cmp-toolpanel__width)
+     * @see https://docs.adaptabletools.com/docs/theming/css-variables#toolpanel
+     */
+    width?: number;
+    /**
+     * The min width of AdapTable ToolPanel
+     * @defaultValue var(--ab-cmp-toolpanel__width)
+     * @see https://docs.adaptabletools.com/docs/theming/css-variables#toolpanel
+     */
+    minWidth?: number;
+    /**
+     * The max width of AdapTable ToolPanel
+     * @defaultValue undefined
+     */
+    maxWidth?: number;
+    /**
+     * Order of displayed ToolPanels in Sidebar
+     *
+     * @defaultValue ['filters', 'columns', 'AdaptableToolPanel']
+     */
+    toolPanelOrder?: ('AdaptableToolPanel' | 'columns' | 'filters')[];
+    /**
+     * Display the Modules dropdown
+     *
+     * @defaultValue true
+     * @gridInfoItem
+     */
+    showModulesDropdown?: boolean;
+    /**
+     * Display the Columns dropdown
+     *
+     * @defaultValue true
+     * @gridInfoItem
+     */
+    showColumnsDropdown?: boolean;
+    /**
+     * Display the Tool Panels dropdown
+     *
+     * @defaultValue true
+     * @gridInfoItem
+     */
+    showToolPanelsDropdown?: boolean;
+    /**
+     * ToolPanel Buttons provided by Users which perform custom behaviour
+     */
+    customToolPanelButtons?: AdaptableButton<ToolPanelButtonContext>[];
+    /**
+     * ToolPanels provided by Users which contain custom content
+     */
+    customToolPanels?: CustomToolPanel[];
+}
+/**
+ * Defines a Custom ToolPanel - provided by Users and contains custom content
+ */
+export interface CustomToolPanel extends AdaptableObject {
+    /**
+     * Name of Custom ToolPanel - should be unique
+     */
+    name: string;
+    /**
+     * Title to display in Custom ToolPanel; if undefined, will default to `name` property
+     */
+    title?: string;
+    /**
+     * Optional set of buttons to show in the ToolPanel
+     */
+    toolPanelButtons?: AdaptableButton<CustomToolPanelButtonContext>[];
+    /**
+     * Function to provide bespoke content when NOT using a Framework wrapper
+     */
+    render?: ({ visible, node, adaptableApi, }: {
+        visible: boolean;
+        node: HTMLDivElement;
+        adaptableApi: AdaptableApi;
+    }) => string | null;
+    /**
+     * Framework-specific (Angular or React) component to be rendered
+     */
+    frameworkComponent?: AdaptableFrameworkComponent;
+}
+/**
+ * Context required by functions when using a ToolPanel Button
+ */
+export interface ToolPanelButtonContext extends ButtonContext {
+    /**
+     * Current ToolPanel State
+     */
+    toolPanelState: ToolPanelState;
+}
+export interface CustomToolPanelButtonContext extends ButtonContext {
+    /**
+     *The Custom ToolPanel which contains the button
+     */
+    customToolPanel: CustomToolPanel;
+    /**
+     * Current ToolPanel State
+     */
+    toolPanelState: ToolPanelState;
+}

package/src/AdaptableOptions/ToolPanelOptions.js

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

package/src/AdaptableOptions/UserInterfaceOptions.d.ts

@@ -0,0 +1,115 @@
+import { AdaptableIcon } from '../PredefinedConfig/Common/AdaptableIcon';
+import { DateInputOptions } from './DateInputOptions';
+import { AdaptableScope } from '../PredefinedConfig/Common/AdaptableScope';
+import { AdaptableColumn } from '../PredefinedConfig/Common/AdaptableColumn';
+import { AdaptableButton, ButtonContext } from '../PredefinedConfig/Common/AdaptableButton';
+import { RowNode } from '@ag-grid-community/all-modules';
+import { AdaptableObject } from '../PredefinedConfig/Common/AdaptableObject';
+import { AdaptableStyle } from '../PredefinedConfig/Common/AdaptableStyle';
+/**
+ * Options for managing the User Interface of AdapTable
+ */
+export interface UserInterfaceOptions {
+    /**
+     * Show Mac-like scrollbars; size is configurable via CSS variable `--ab-custom-scrollbar-size` (default: `10px`)
+     *
+     * @defaultValue false
+     * @gridInfoItem
+     */
+    useCustomMacLikeScrollbars?: boolean;
+    /**
+     * The application icon to appear in Dashboard and elsewhere (e.g. OpenFin notifications)
+     *
+     * @defaultValue null
+     */
+    applicationIcon?: AdaptableIcon;
+    /**
+     * Options for managing and customizing date inputs in AdapTable
+     */
+    dateInputOptions?: DateInputOptions;
+    /**
+     * List of values which are permitted (e.g. to show in filter)
+     */
+    permittedValues?: CellValuesList[];
+    /**
+     * Dropdown values displayed when column is being edited
+     */
+    editLookUpItems?: CellValuesList[];
+    /**
+     * Colours to display in Colour Picker (in place of AdapTable's default set)
+     */
+    colorPalette?: string[] | (() => string[]);
+    /**
+     * Columns which contain an AdapTable Button - used for performing Actions
+     */
+    actionColumns?: ActionColumn[];
+    /**
+     * Style to set for editable cells
+     */
+    editableCellStyle?: AdaptableStyle;
+    /**
+     * Style to set for non-editable cells
+     */
+    readOnlyCellStyle?: AdaptableStyle;
+    /**
+     * Optional list of CSS styles that can be used when creating Adaptable Styles in Adaptable (e.g. in Conditional Style, Format Column and other Modules)
+     *
+     * @gridInfoItem
+     */
+    styleClassNames?: string[];
+    /**
+     * Provide links to AdapTable documentation (in Module popups and Expression Editor)
+     *
+     * @defaultValue true
+     * @gridInfoItem
+     */
+    showDocumentationLinks?: boolean;
+}
+export interface CellValuesList {
+    /**
+     * Scope where Values will appear (Mandatory property)
+     */
+    scope: AdaptableScope;
+    /**
+     * Values to display: either hardcoded list or a function
+     */
+    values?: any[] | ((column: AdaptableColumn) => any[]);
+}
+/**
+ * A Special Column that wraps an AdapTable Button
+ */
+export interface ActionColumn extends AdaptableObject {
+    /**
+     * Mandatory 'Id'; if no value set for `FriendlyName`, this will also be Column name
+     */
+    columnId: string;
+    /**
+     * How Column appears in Column Header, Menus; if no value set, `ColumnId` is used
+     */
+    friendlyName?: string;
+    /**
+     * Button to display in the Column
+     */
+    actionColumnButton: AdaptableButton<ActionColumnButtonContext>;
+    /**
+     * Shows Action Column also in grouped rows
+     */
+    includeGroupedRows?: boolean;
+}
+/**
+ * Context required by functions when using an Action Column Button
+ */
+export interface ActionColumnButtonContext extends ButtonContext {
+    /**
+     * Action Column in question
+     */
+    actionColumn: ActionColumn;
+    /**
+     * Primary Key Value in current row
+     */
+    primaryKeyValue: any;
+    /**
+     * Current Row Node
+     */
+    rowNode: RowNode;
+}

package/src/AdaptableOptions/UserInterfaceOptions.js

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

package/src/Api/AdaptableApi.d.ts

@@ -0,0 +1,185 @@
+import { SparklineColumnApi } from './SparklineColumnApi';
+import { AlertApi } from './AlertApi';
+import { PluginsApi } from './PluginsApi';
+import { BulkUpdateApi } from './BulkUpdateApi';
+import { CalculatedColumnApi } from './CalculatedColumnApi';
+import { CellSummaryApi } from './CellSummaryApi';
+import { ConfigApi } from './ConfigApi';
+import { ConditionalStyleApi } from './ConditionalStyleApi';
+import { CustomSortApi } from './CustomSortApi';
+import { DashboardApi } from './DashboardApi';
+import { ToolPanelApi } from './ToolPanelApi';
+import { DataSourceApi } from './DataSourceApi';
+import { EventApi } from './EventApi';
+import { ExportApi } from './ExportApi';
+import { FormatColumnApi } from './FormatColumnApi';
+import { FreeTextColumnApi } from './FreeTextColumnApi';
+import { LayoutApi } from './LayoutApi';
+import { PlusMinusApi } from './PlusMinusApi';
+import { QuickSearchApi } from './QuickSearchApi';
+import { ShortcutApi } from './ShortcutApi';
+import { SmartEditApi } from './SmartEditApi';
+import { FilterApi } from './FilterApi';
+import { SystemStatusApi } from './SystemStatusApi';
+import { ThemeApi } from './ThemeApi';
+import { UserInterfaceApi } from './UserInterfaceApi';
+import { InternalApi } from './InternalApi';
+import { GridApi } from './GridApi';
+import { ScheduleApi } from './ScheduleApi';
+import { QueryApi } from './QueryApi';
+import { TeamSharingApi } from './TeamSharingApi';
+import { ColumnApi } from './ColumnApi';
+import { ApplicationApi } from './ApplicationApi';
+import { ScopeApi } from './ScopeApi';
+import { PredicateApi } from './PredicateApi';
+/**
+ *
+ * The `AdaptableApi` provides developers with run-time access to AdapTable.
+ *
+ * Has a huge number of classes each dedicated to a specific AdapTable Module or functionality
+ */
+export interface AdaptableApi {
+    /**
+     * Provides access to the Alert Module
+     */
+    alertApi: AlertApi;
+    /**
+     * Provides access to the Application Module
+     */
+    applicationApi: ApplicationApi;
+    /**
+     * Provides access to the Bulk Update Module
+     */
+    bulkUpdateApi: BulkUpdateApi;
+    /**
+     * Provides access to the Calculated Column Module
+     */
+    calculatedColumnApi: CalculatedColumnApi;
+    /**
+     * Provides access to the Cell Summary Module
+     */
+    cellSummaryApi: CellSummaryApi;
+    /**
+     * Provides a number of column-related methods
+     */
+    columnApi: ColumnApi;
+    /**
+     * Methods giving access to Adaptable State
+     */
+    configApi: ConfigApi;
+    /**
+     * Provides access to the Conditional Style Module
+     */
+    conditionalStyleApi: ConditionalStyleApi;
+    /**
+     * Provides access to the Custom Sort Module
+     */
+    customSortApi: CustomSortApi;
+    /**
+     * Provides access to the Dashboard
+     */
+    dashboardApi: DashboardApi;
+    /**
+     * Provides access to the Data Source Module
+     */
+    dataSourceApi: DataSourceApi;
+    /**
+     * Used for listenning / subscribing to the various Events published by AdapTable
+     */
+    eventApi: EventApi;
+    /**
+     * Provides access to the Export Module and Reports
+     */
+    exportApi: ExportApi;
+    /**
+     * Provides access to AdapTable's filtering functionality
+     */
+    filterApi: FilterApi;
+    /**
+     * Provides access to the Format Column Module
+     */
+    formatColumnApi: FormatColumnApi;
+    /**
+     * Provides access to the FreeText Column Module
+     */
+    freeTextColumnApi: FreeTextColumnApi;
+    /**
+     * Provides methods for managing the Grid, and Grid data, directly
+     */
+    gridApi: GridApi;
+    /**
+     * Provides access to the Layout Module
+     */
+    layoutApi: LayoutApi;
+    /**
+     * Provides access to the Plus Minus Module
+     */
+    plusMinusApi: PlusMinusApi;
+    /**
+     * Offers access to AdapTable Plugin (e.g. charts, ipushpull, OpenFin etc)
+     */
+    pluginsApi: PluginsApi;
+    /**
+     * Manages the Predicate - a  boolean-return function used in Filters and Alerts
+     */
+    predicateApi: PredicateApi;
+    /**
+     * Provides access to functions related to the cross-column Query
+     */
+    queryApi: QueryApi;
+    /**
+     * Provides access to the Quick Search Module
+     */
+    quickSearchApi: QuickSearchApi;
+    /**
+     * Provides access to the Schedule Module
+     */
+    scheduleApi: ScheduleApi;
+    /**
+     * Manages the `Scope` object - used widely to determine where objects are applied
+     */
+    scopeApi: ScopeApi;
+    /**
+     * Provides access to the Shortcut Module
+     */
+    shortcutApi: ShortcutApi;
+    /**
+     * Provides access to the Smart Edit Module
+     */
+    smartEditApi: SmartEditApi;
+    /**
+     * Provides access to the Sparkline Column in the Charts Plugin
+     */
+    sparklineColumnApi: SparklineColumnApi;
+    /**
+     * Methods related to displaying System Status and application health messages
+     */
+    systemStatusApi: SystemStatusApi;
+    /**
+     * Api methods related to Theme management
+     */
+    themeApi: ThemeApi;
+    /**
+     * Provides access to the AdapTable Tool Panel on the right hand side of the grid
+     */
+    toolPanelApi: ToolPanelApi;
+    /**
+     * Manages User Interface Options where colours, styles and permitted values are configured
+     */
+    userInterfaceApi: UserInterfaceApi;
+    /**
+     * Functions related to run-time Team Sharing of AdapTable objects between colleagues
+     */
+    teamSharingApi: TeamSharingApi;
+    /**
+     * Api methods used *internally* within AdapTable.
+     */
+    internalApi: InternalApi;
+    /**
+     * Cleanup method - should be called only when using the vanilla javascript component, as framework components cleanup is performed when the component is destroyed/unmounted.
+     */
+    destroy: (config?: {
+        unmount: boolean;
+        destroyApi?: boolean;
+    }) => void;
+}

package/src/Api/AdaptableApi.js

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