@adaptabletools/adaptable 14.0.0-canary.0 → 14.0.0-canary.1

package/src/Api/TeamSharingApi.d.ts

@@ -15,12 +15,6 @@ export interface TeamSharingApi {
      * @return either TRUE if the shared entities were successfully set or FALSE if the shared entities were not set
      */
     setSharedEntities(sharedEntities: SharedEntity[]): Promise<boolean>;
-    /**
-     * Whether Team Sharing is Activated
-     *
-     * @deprecated use `Adaptable.isTeamSharingAvailable()` instead
-     */
-    isTeamSharingActivated(): boolean;
     /**
      * Whether Team Sharing is Available to use
      */
@@ -32,16 +26,11 @@ export interface TeamSharingApi {
     /**
      * Opens Settings Panel with Team Sharing section selected and visible
      */
-    showTeamSharingPopup(): void;
+    openTeamSharingSettingsPanel(): void;
     /**
      * Checks if active Shared Entities have updates (higher revisions than the local counterpart objects)
      */
     checkForUpdates(): void;
-    /**
-     * Fires the Team Sharing Entity Changed Event
-     * @param sharedEntity Entity that has been changed
-     */
-    fireTeamSharingEntityChangedEvent(sharedEntity: SharedEntity): void;
     /**
      * Puts an Adaptable Object into Team Share
      * @param entity entity to Share
@@ -65,12 +54,10 @@ export interface TeamSharingApi {
      */
     getLoadedSharedEntities(): SharedEntity[];
     /**
-     * Trigger loading of shared entries.
-     * By default shared entries are loaded when the Team Sharing popup is visible.
+     * TO BE REMOVED
      */
-    triggerLoadingTeamSharingEntries(): void;
     /**
-     * Retrieves shared entry dependencies.
+     *@deprecated use `openTeamSharingSettingsPanel()` instead
      */
-    getSharedEntryDependencies(sharedEntry: SharedEntity): SharedEntity[];
+    showTeamSharingPopup(): void;
 }

package/src/Api/ThemeApi.d.ts

@@ -1,4 +1,4 @@
-import { ThemeState, AdaptableTheme } from '../PredefinedConfig/ThemeState';
+import { AdaptableTheme, ThemeState } from '../PredefinedConfig/ThemeState';
 /**
  * Provides run-time access to the Theme Module and associated state
  */
@@ -43,21 +43,40 @@ export interface ThemeApi {
     /**
      * Retrieves System Themes in State
      */
-    getAllSystemTheme(): AdaptableTheme[];
+    getSystemThemes(): AdaptableTheme[];
     /**
      * Retrieves User Themes in State
      */
-    getAllUserTheme(): AdaptableTheme[];
+    getUserThemes(): AdaptableTheme[];
     /**
-     * Retrieves all Themes (both System User) in State
+     * Retrieves all Themes (both System &  User) in State
      */
-    getAllTheme(): AdaptableTheme[];
+    getThemes(): AdaptableTheme[];
     /**
      * Opens Settings Panel with Theme section selected and visible
      */
-    showThemePopup(): void;
+    openThemeSettingsPanel(): void;
     /**
      * Get the name of the current AG Grid theme
      */
     getAgGridCurrentThemeName(): string;
+    /**
+     * TO BE REMOVED
+     */
+    /**
+     * @deprecated use `getSystemThemes()` instead
+     */
+    getAllSystemTheme(): AdaptableTheme[];
+    /**
+     * @deprecated use `getUserThemes()` instead
+     */
+    getAllUserTheme(): AdaptableTheme[];
+    /**
+     * @deprecated use `getThemes()` instead
+     */
+    getAllTheme(): AdaptableTheme[];
+    /**
+     * @deprecated use `openThemeSettingsPanel()` instead
+     */
+    showThemePopup(): void;
 }

package/src/Api/ToolPanelApi.d.ts

@@ -1,7 +1,7 @@
 import { ToolPanelState, ToolPanelVisibilityMode } from '../PredefinedConfig/ToolPanelState';
 import { CustomToolPanel, ToolPanelButtonContext } from '../AdaptableOptions/ToolPanelOptions';
 import { AdaptableButton } from '../PredefinedConfig/Common/AdaptableButton';
-import { AdaptableToolPanel } from '../PredefinedConfig/Common/Types';
+import { AdaptableModuleButtons, AdaptableToolPanel } from '../PredefinedConfig/Common/Types';
 /**
  * Functions for managing the AdapTable ToolPanel Component (at side of grid)
  */
@@ -47,4 +47,13 @@ export interface ToolPanelApi {
      * @param visibilityMode
      */
     setCustomToolPanelVisibilityMode(customToolPanelName: string, visibilityMode: ToolPanelVisibilityMode): void;
+    /**
+     * Sets the Module buttons in the Adaptable ToolPanel
+     * @param moduleButtons the module buttons
+     */
+    setModuleButtons(moduleButtons: AdaptableModuleButtons): void;
+    /**
+     * Sets the Module buttons from the Adaptable ToolPanel
+     */
+    getModuleButtons(): AdaptableModuleButtons;
 }

package/src/Api/UserInterfaceApi.d.ts

@@ -19,7 +19,7 @@ export interface UserInterfaceApi {
     /**
      * Retrieves `permittedValues` property from User Interface Options
      */
-    getAllPermittedValuesItems(): PermittedValues[];
+    getPermittedValuesItems(): PermittedValues[];
     /**
      * Retrieves Permitted Values for a given Column
      * @param column column for which to retrieve Permitted Values
@@ -40,7 +40,7 @@ export interface UserInterfaceApi {
     /**
      * Retrieves `editLookUpItems` property from User Interface Options
      */
-    getAllEditLookUpItems(): EditLookUpPermittedValues[];
+    getEditLookUpItems(): EditLookUpPermittedValues[];
     /**
      * Retrieves EditLookUpItems for a given Column
      * @param columnId Column for which to retrieve EditLookUpItems
@@ -74,4 +74,15 @@ export interface UserInterfaceApi {
      * Retrieves any Object Tags (provided in User Interface Options)
      */
     getAdaptableObjectTags(): AdaptableObjectTag[] | undefined;
+    /**
+     * TO BE REMOVED
+     */
+    /**
+     * @deprecated use `getPermittedValuesItems()` instead
+     */
+    getAllPermittedValuesItems(): PermittedValues[];
+    /**
+     * @deprecated use `getEditLookUpItems()` instead
+     */
+    getAllEditLookUpItems(): EditLookUpPermittedValues[];
 }

package/src/PredefinedConfig/AdaptableState.d.ts

@@ -23,6 +23,7 @@ import { QueryState } from './QueryState';
 import { FlashingCellState } from './FlashingCellState';
 import { StatusBarState } from './StatusBarState';
 import { ChartingState } from './ChartingState';
+import { StyledColumnState } from './StyledColumnState';
 /**
  * The main state object of Adaptable
  */
@@ -48,6 +49,7 @@ export interface AdaptablePersistentState {
     Query: QueryState;
     QuickSearch: QuickSearchState;
     Schedule: ScheduleState;
+    StyledColumn: StyledColumnState;
     Shortcut: ShortcutState;
     StatusBar: StatusBarState;
     TeamSharing: TeamSharingState;

package/src/PredefinedConfig/AlertState.d.ts

@@ -10,7 +10,7 @@ import { AdaptableStyle } from './Common/AdaptableStyle';
 import { XOR } from '../Utilities/Extensions/TypeExtensions';
 import { AdaptableAggregatedBooleanQuery, AdaptableBooleanQuery, AdaptableObservableQuery } from './Common/AdaptableQuery';
 import { ButtonStyle } from './Common/ButtonStyle';
-import { AlertFormContext, BaseContext } from '../types';
+import { AlertFormContext, BaseContext, NotificationsOptions } from '../types';
 /**
  * Predefined Configuration for Alert Module
  */
@@ -36,6 +36,10 @@ export interface AlertDefinition extends SuspendableObject {
      * Type of Alert: 'Info', 'Success', 'Warning', 'Error'; influences Alert colour, icon and logging
      */
     MessageType: AdaptableMessageType;
+    /**
+     * The Alert Title Message to display
+     */
+    MessageHeader?: string;
     /**
      * Alert Message; if not provided AdapTable creates dynamically using Rule & Scope (Note: can be provided as a function in AlertOptions)
      */
@@ -49,7 +53,7 @@ export interface AlertDefinition extends SuspendableObject {
      */
     AlertForm?: string | AlertButtonForm;
 }
-export declare type AlertButtonForm = Omit<AdaptableForm<AlertFormContext>, 'title' | 'buttons' | 'fields' | 'description'> & {
+export declare type AlertButtonForm = Omit<AdaptableForm<AlertFormContext>, 'title' | 'buttons' | 'description'> & {
     Buttons?: AlertButton<AlertFormContext>[];
 };
 export interface AlertDefinitionPredicate extends AdaptablePredicate {
@@ -59,7 +63,7 @@ export interface AlertDefinitionPredicate extends AdaptablePredicate {
  * The Alert Rule defined by either an AdaptablePredicate or an AdaptableQuery
  */
 export declare type AlertRule = XOR<{
-    Predicate: AlertDefinitionPredicate;
+    Predicates: AlertDefinitionPredicate[];
 }, AdaptableAlertQuery>;
 /**
  *  Alert Query which may be either a Boolean, Observable or AggregatedBoolean Expression
@@ -73,7 +77,7 @@ export interface AlertButton<AlertFormContext> extends Omit<AdaptableButton<Base
     /**
      * Predefined Action(s) to trigger when button is clicked; but the implementation in `actionHandlers` property of Alert Options
      */
-    Action?: AdaptableAlertAction | AdaptableAlertAction[] | string | string[];
+    Action?: AdaptableAlertAction | AdaptableAlertAction[] | string | string[] | ((context: AlertFormContext) => void);
     /**
      * Label to show in the Button
      */
@@ -96,6 +100,10 @@ export interface AlertProperties {
      * Displays a notification when Alert is triggered
      */
     DisplayNotification?: boolean;
+    /**
+     * Notifiction duration, it defaults to NotificationOptions.duration
+     */
+    NotificationDuration?: NotificationsOptions['duration'];
     /**
      * Colours updated cell using `MessageType` property of triggering Alert Definition
      */
@@ -126,4 +134,11 @@ export interface AlertProperties {
      */
     PreventEdit?: boolean;
 }
-export declare type SystemAlertPredicateId = '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' | 'PercentChange' | 'PrimaryKeyDuplicate' | 'ExistingValuesOnly' | 'NoDuplicateValues' | 'IsNumeric' | 'IsNotNumeric' | 'AddedRow' | 'RemovedRow' | 'Any';
+/**
+ * Array containing all System Alert Predicates
+ */
+export declare type SystemAlertPredicateIds = SystemAlertPredicateId[];
+/**
+ * List of System Predicates available for Alerts
+ */
+export declare type SystemAlertPredicateId = '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' | 'WorkDay' | 'Holiday' | 'True' | 'False' | 'PercentChange' | 'PrimaryKeyDuplicate' | 'ExistingValuesOnly' | 'NoDuplicateValues' | 'IsNumeric' | 'IsNotNumeric' | 'AddedRow' | 'RemovedRow' | 'Any';

package/src/PredefinedConfig/ChartingState.d.ts

@@ -1,20 +1,29 @@
 import { ChartModel } from '@ag-grid-community/core';
+import { AdaptableObject } from '../types';
 import { ConfigState } from './ConfigState';
 /**
  * Wraps an AG Grid Chart Model
  */
-export interface ChartDefinition {
+export interface ChartDefinition extends AdaptableObject {
+    /**
+     * Name of the Chart
+     */
+    Name: string;
     /**
      * AG Grid Chart Model
      */
-    model: ChartModel;
+    Model: ChartModel;
 }
 /**
- * Used for persisting AG Grids in Adaptable State
+ * Persists AG Grid Charts in Adaptable State
  */
 export interface ChartingState extends ConfigState {
     /**
-     * Charting Definitions - wrap AG Grid Chart Models
+     * Wrappers around AG Grid Chart Models
      */
     ChartDefinitions?: ChartDefinition[];
 }
+/**
+ * Aggregation function used in the Chart
+ */
+export declare type ChartingAggFunc = 'sum' | 'min' | 'max' | 'count' | 'avg' | 'first' | 'last';

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

@@ -2,7 +2,7 @@ import { AdaptableObject } from './AdaptableObject';
 /**
  * Type of data stored in an Adaptable Column
  */
-export declare type AdaptableColumnDataType = 'String' | 'Number' | 'Boolean' | 'Date' | 'Object' | 'Unknown';
+export declare type AdaptableColumnDataType = 'String' | 'Number' | 'Boolean' | 'Date' | 'Object' | 'NumberArray' | 'TupleNumberArray' | 'ObjectNumberArray' | 'Unknown';
 /**
  * Base class for Adaptable Column containing most important properties
  */

package/src/PredefinedConfig/Common/AdaptableColumn.js

@@ -1,6 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.isValidOrderForColumnGroups = void 0;
+const isAdaptableColumn = (input) => {
+    return (typeof (input === null || input === void 0 ? void 0 : input.columnId) === 'string' &&
+        typeof input.dataType === 'string');
+};
 // this is only implemented for 1 level groups
 const isValidOrderForColumnGroups = ({ oldColumns, newColumns, }) => {
     const getGroups = (columns) => {

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

@@ -1,5 +1,4 @@
 import { AdaptableButton } from './AdaptableButton';
-import { AdaptableFormConfig } from '../../components/FormLayout';
 import { BaseContext } from '../../types';
 export declare type AdaptableFormData = Record<string, any>;
 /**
@@ -22,10 +21,6 @@ export interface AdaptableForm<T extends BaseContext> {
      * Buttons to include in the Form
      */
     buttons?: AdaptableButton<T>[];
-    /**
-     * @internal do NOT use this property as it's in an experimental phase
-     */
-    config?: AdaptableFormConfig;
 }
 /**
  * Defines a Field that appears in an Adaptable Form

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

@@ -42,6 +42,11 @@ export interface NumberFormatterOptions extends BaseFormatterOptions {
      * Suffix to use after the number
      */
     Suffix?: string;
+    /**
+     * Replaces the value. Usefull when in combination with a Condition
+     * e.g. replace null/undefiend with '-'
+     */
+    Content?: string | number;
     /**
      * Multiplier to use on the number
      */
@@ -84,4 +89,9 @@ export interface StringFormatterOptions extends BaseFormatterOptions {
      * Suffix to use after the cell text
      */
     Suffix?: string;
+    /**
+     * Replaces the value. Usefull when in combination with a Condition
+     * e.g. replace null/undefiend with 'N/A'
+     */
+    Content?: string;
 }

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

@@ -51,4 +51,4 @@ export interface AdaptableBaseIcon {
 /**
  * All AdapTable internal icon names
  */
-export declare type AdaptableInternalIconName = 'add' | 'add-row' | 'alert' | 'align-justify' | 'analysis' | 'application' | 'arrow-down' | 'arrow-left' | 'arrow-right' | 'arrow-up' | 'arrow-up-long' | 'arrow-down-long' | 'arrowexpand' | 'attach-file' | 'blanks' | 'boolean-list' | 'broadcast' | 'build' | 'bulk-update' | 'calculated-column' | 'calendar' | 'call' | 'campaign' | 'cell-summary' | 'cell-validation' | 'chart' | 'chat' | 'check' | 'check-circle' | 'checked' | 'clear' | 'clone' | 'close' | 'cloud-upload' | 'collapse' | 'column-add' | 'column-chooser' | 'column-filter' | 'comment' | 'conditional-style' | 'contains' | 'custom-sort' | 'dashboard' | 'data-set' | 'date-range' | 'delete' | 'division' | 'dock' | 'drag' | 'edit' | 'ends-with' | 'equal' | 'equation' | 'error' | 'expand' | 'exponent' | 'export' | 'export-data' | 'fast-backward' | 'fast-forward' | 'filter' | 'flashing-cell' | 'folder' | 'folder-open' | 'folder-shared' | 'format-column' | 'freetext-column' | 'function' | 'gradient-column' | 'greater-than' | 'greater-than-or-equal' | 'hide-column' | 'history' | 'home' | 'import-export' | 'info' | 'instrument' | 'invalid' | 'ipushpull' | 'justify' | 'layout' | 'less-than' | 'less-than-or-equal' | 'list' | 'login' | 'logout' | 'menu' | 'minus' | 'multiplication' | 'newpage' | 'news' | 'non-blanks' | 'not-contains' | 'not-equal' | 'ok' | 'pause' | 'percent' | 'percent-bar' | 'person' | 'pie-chart' | 'play' | 'plus' | 'plus-minus' | 'query' | 'quick-search' | 'quote' | 'refresh' | 'regex' | 'reminder' | 'save' | 'schedule' | 'settings' | 'shortcut' | 'show-column' | 'smart-edit' | 'sort-asc' | 'sort-desc' | 'spark-line' | 'starts-with' | 'state-management' | 'statusbar' | 'stop' | 'system-status' | 'tab-unselected' | 'team-share' | 'theme' | 'tool-panel' | 'track-changes' | 'trash' | 'triangle-down' | 'triangle-up' | 'unchecked' | 'undo' | 'updated-row' | 'upload' | 'warning';
+export declare type AdaptableInternalIconName = 'add' | 'add-row' | 'alert' | 'align-justify' | 'analysis' | 'application' | 'arrow-down' | 'arrow-left' | 'arrow-right' | 'arrow-up' | 'arrow-up-long' | 'arrow-down-long' | 'arrowexpand' | 'attach-file' | 'blanks' | 'boolean-list' | 'broadcast' | 'brush' | 'build' | 'bulk-update' | 'calculated-column' | 'calendar' | 'call' | 'campaign' | 'cell-summary' | 'cell-validation' | 'chart' | 'chat' | 'check' | 'check-circle' | 'checked' | 'clear' | 'clone' | 'close' | 'cloud-upload' | 'collapse' | 'column-add' | 'column-chooser' | 'column-filter' | 'comment' | 'contains' | 'custom-sort' | 'dashboard' | 'data-set' | 'date-range' | 'delete' | 'division' | 'dock' | 'drag' | 'edit' | 'ends-with' | 'equal' | 'equation' | 'error' | 'expand' | 'exponent' | 'export' | 'export-data' | 'fast-backward' | 'fast-forward' | 'filter' | 'flashing-cell' | 'folder' | 'folder-open' | 'folder-shared' | 'format-column' | 'freetext-column' | 'function' | 'gradient-column' | 'greater-than' | 'greater-than-or-equal' | 'hide-column' | 'history' | 'home' | 'import-export' | 'info' | 'instrument' | 'invalid' | 'ipushpull' | 'justify' | 'layout' | 'less-than' | 'less-than-or-equal' | 'list' | 'login' | 'logout' | 'menu' | 'minus' | 'multiplication' | 'newpage' | 'news' | 'non-blanks' | 'not-contains' | 'not-equal' | 'ok' | 'open-in-new' | 'pause' | 'percent' | 'percent-bar' | 'person' | 'pie-chart' | 'play' | 'plus' | 'plus-minus' | 'query' | 'quick-search' | 'quote' | 'refresh' | 'regex' | 'reminder' | 'save' | 'schedule' | 'settings' | 'shortcut' | 'show-column' | 'smart-edit' | 'sort-asc' | 'sort-desc' | 'spark-line' | 'starts-with' | 'state-management' | 'statusbar' | 'stop' | 'system-status' | 'tab-unselected' | 'team-share' | 'theme' | 'tool-panel' | 'track-changes' | 'trash' | 'triangle-down' | 'triangle-up' | 'unchecked' | 'undo' | 'updated-row' | 'upload' | 'warning';

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

@@ -1,4 +1,5 @@
 import { TypeUuid } from '../Uuid';
+import { AdaptableScope } from './AdaptableScope';
 /**
  * Base interface which all other Adaptable State-related objects extend
  */
@@ -21,6 +22,26 @@ export interface AdaptableObject {
     Tags?: AdaptableObjectTag[];
 }
 /**
- * AdaptableObjectTag Object Tague - currently supporting only plain string values, but open for future extensions, if ever needed.
+ * AdaptableObjectTag Object Tag - currently supporting only plain string values, but open for future extensions, if ever needed.
  */
 export declare type AdaptableObjectTag = string;
+/**
+ * Lookup criteria for finding specific AdaptableObjects. All given criteria will be composed with an AND operator.
+ */
+export interface AdaptableObjectLookupCriteria {
+    /**
+     * AdaptableScope
+     */
+    scope?: AdaptableScope;
+    /**
+     * AdaptableObjectTag
+     */
+    tag?: AdaptableObjectTag;
+    /**
+     * Technical IDs of Adaptable Objects
+     */
+    ids?: AdaptableObject['Uuid'][];
+}
+export interface AdaptableObjectWithScope extends AdaptableObject {
+    Scope: AdaptableScope;
+}

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

@@ -34,7 +34,7 @@ export interface AdaptablePredicateDef {
     /**
      * Modules where the Predicate can run
      */
-    moduleScope: ModuleScope[];
+    moduleScope: PredicateModuleScope[];
     /**
      * Inputs the Predicate can take
      */
@@ -103,12 +103,18 @@ export interface PredicateDefHandlerParams {
 export interface PredicateDefToStringParams {
     inputs: any[];
 }
-export declare type ModuleScope = 'filter' | 'alert' | 'conditionalstyle' | 'flashingcell';
+export declare type PredicateModuleScope = 'filter' | 'alert' | 'flashingcell' | 'formatColumn';
 /**
  * Array of Predicate Defs which are shipped by AdapTable
  */
 export declare const SystemPredicateDefs: AdaptablePredicateDef[];
 export declare const SystemFilterPredicateIds: string[];
+export declare const SystemAlertPredicateIds: string[];
+export declare const SystemFormatColumnPredicateIds: string[];
+export declare const SystemFlashingCellPredicateIds: string[];
+/**
+ * Column Filter Definition for a specific Column
+ */
 export interface ColumnFilterDef {
     dataType: AdaptableColumnDataType;
     predicate: AdaptablePredicateDef;