@adaptabletools/adaptable 13.1.1 → 14.0.0-canary.1

package/src/Api/AlertApi.d.ts

@@ -1,10 +1,11 @@
-import { AlertState, AlertDefinition, AdaptableAlertAction, AlertButton } from '../PredefinedConfig/AlertState';
+import { AdaptableAlertAction, AlertButton, AlertDefinition, AlertState } from '../PredefinedConfig/AlertState';
 import { CellDataChangedInfo } from '../PredefinedConfig/Common/CellDataChangedInfo';
 import { AdaptableScope } from '../PredefinedConfig/Common/AdaptableScope';
 import { AdaptablePredicateDef } from '../PredefinedConfig/Common/AdaptablePredicate';
 import { AdaptableAlert } from '../PredefinedConfig/Common/AdaptableAlert';
-import { AdaptableForm, AdaptableFormData } from '../PredefinedConfig/Common/AdaptableForm';
+import { AdaptableFormData } from '../PredefinedConfig/Common/AdaptableForm';
 import { AdaptableMessageType, AlertFormContext, AlertProperties, GridDataChangedInfo } from '../types';
+import { AdaptableObjectLookupCriteria } from '../PredefinedConfig/Common/AdaptableObject';
 /**
  * Provides run-time access to Alert function and associated State
  */
@@ -15,12 +16,10 @@ export interface AlertApi {
      */
     getAlertState(): AlertState;
     /**
-     * Retrieeves the Adaptable Form with the given name
-     * @param name name of the Form
+     * Opens Settings Panel with Alert section selected and visible
      */
-    getAdaptableFormByName(name: string): AdaptableForm<AlertFormContext> | undefined;
+    openAlertSettingsPanel(): void;
     /**
-     *
      * Retrieves all Alert Definitions in Alert State
      * @returns alert definitions
      */
@@ -28,169 +27,205 @@ export interface AlertApi {
         includeLayoutNotAssociatedObjects?: boolean;
     }): AlertDefinition[];
     /**
-     * Retrieves alert definition by id
+     * Retrieves all Alert Definitions which are currently suspended
+     */
+    getSuspendedAlertDefinitions(config?: {
+        includeLayoutNotAssociatedObjects?: boolean;
+    }): AlertDefinition[];
+    /**
+     * Retrieves all Alert Definitions which are currently active
+     */
+    getActiveAlertDefinitions(config?: {
+        includeLayoutNotAssociatedObjects?: boolean;
+    }): AlertDefinition[];
+    /**
+     * Retrieves alert definition by the technical ID (from `AlertState`)
      * @param id alert definition id
      * @returns alert definition
      */
     getAlertDefinitionById(id: AlertDefinition['Uuid']): AlertDefinition;
     /**
-     * Retrieves all Alert Definitions in Alert State which are NOT Reactive (BooleanQuery)
-     * @returns alert definitions
+     * Adds given Alert Definition to Adaptable State
+     * @param alertDefinition AlertDefinition to add
+     * @returns alert definition
      */
-    getNonReactiveAlertDefinitions(): AlertDefinition[];
+    addAlertDefinition(alertDefinition: AlertDefinition): AlertDefinition;
     /**
-     * Retrieves all active (non-suspended) Alert Definitions in Alert State which are NOT Reactive (BooleanQuery)
-     * @returns alert definitions
+     * Updates given Alert Definition in Adaptable State
+     * @param alertDefinition Alert to Edit
+     * @returns alert definition
      */
-    getActiveNonReactiveAlertDefinitions(): AlertDefinition[];
+    editAlertDefinition(alertDefinition: AlertDefinition): AlertDefinition;
     /**
-     *
-     * Retrieves all Alert Definitions in Alert State which are reactive (ObservableQuery & AggregationQuery)
-     * @returns alert definitions
+     * Deletes given Alert Definition from Adaptable State
+     * @param alertDefinition
      */
-    getReactiveAlertDefinitions(): AlertDefinition[];
+    deleteAlertDefinition(alertDefinition: AlertDefinition): void;
     /**
+     * Suspends Alert Definition
+     * @param alertDefinition Alert to suspend
      *
-     * Retrieves all active (non-suspended) Alert Definitions in Alert State which are reactive (ObservableQuery & AggregationQuery)
-     * @returns alert definitions
      */
-    getActiveReactiveAlertDefinitions(): AlertDefinition[];
+    suspendAlertDefinition(alertDefinition: AlertDefinition): AlertDefinition;
     /**
-     * Retrieves all Alert Definitions which prevent a Cell Edit
-     * @returns alert definitions
+     * Activates a suspended Alert Definition
+     * @param alertDefinition - Alert to Un-suspend (activate)
+     * @returns alert definition
      */
-    getAlertDefinitionsWithPreventEdit(): AlertDefinition[];
+    unSuspendAlertDefinition(alertDefinition: AlertDefinition): AlertDefinition;
     /**
-     * Retrieves all Alert Definitions which allow a Cell Edit
-     *  @returns alert definitions
+     * Evaluate all existing alerts which match the given criteria
+     * @param alertLookupCriteria AdaptableObjectLookupCriteria
      */
-    getAlertDefinitionsWithAllowEdit(): AlertDefinition[];
+    evaluateAlerts(alertDefinitions: AlertDefinition[]): void;
     /**
-     * Adds new Alert Definition
-     * @param alertDefinition AlertDefinition to add
-     * @returns alert definition
+     * Find all Alert Definitions which match the given criteria
+     * @param alertLookupCriteria lookup criteria
      */
-    addAlertDefinition(alertDefinition: AlertDefinition): AlertDefinition;
+    findAlertDefinitions(alertLookupCriteria: AdaptableObjectLookupCriteria): AlertDefinition[];
     /**
      * Displays given Alert as a Popup
      * @param alertToDisplay the Alert to show as a Popup
+     *
+     * @deprecated use `showAdaptableAlertAsToast()` instead
      */
     displayMessageAlertPopup(alertToDisplay: AdaptableAlert): void;
     /**
-     * Displays (fully formed) inputted Alert to the User
-     * @param alertToShow The Alert which should be displayed
+     * Displays given Alert as a Toast
+     * @param alert the Alert to show as a Toast
      */
-    displayAlert(alertToShow: AdaptableAlert): Promise<any>;
+    showAdaptableAlertAsToast(alert: AdaptableAlert): void;
     /**
-     * Publishes an event when an Alert is triggered
-     * @param alertToFire Alerts which has just triggered
+     * Displays the given Adaptable Alert
+     * @param alert The Alert which should be displayed
      */
-    publishAlertFiredEvent(alertToFire: AdaptableAlert): void;
-    /**
-     * Runs after a button in an Alert Form is clicked
-     */
-    executeAlertButton(button: AlertButton<AlertFormContext>, context: AlertFormContext): void;
+    showAdaptableAlert(alertToShow: AdaptableAlert): Promise<void>;
     /**
-     * Runs after an Alert Action is invoked
-     * @param actionName Action which has been invoked
-     * @param details Info about the Alert and Form
-     */
-    executeAlertAction(actionName: AdaptableAlertAction | string, details: {
-        alertDefinition: AlertDefinition;
-        cellDataChangedInfo?: CellDataChangedInfo;
-        gridDataChangedInfo?: GridDataChangedInfo;
-        formData?: AdaptableFormData;
-    }): void;
-    /**
-     * Creates Alert formed from inputted values and displays it.
+     * Creates Alert based on given parameters and displays it.
      * @param alertHeader Header of the Alert (if shown in a popup its the Title of the Window)
      * @param alertMessage Main message of the alert
      */
-    showAlert(alertHeader: string, alertMessage: string, messageType: AdaptableMessageType, alertProperties?: AlertProperties): void;
+    showAlert(alertHeader: string, alertMessage: string, messageType: AdaptableMessageType, alertProperties?: AlertProperties): Promise<void>;
     /**
-     * Creates Alert formed from inputted values and displays it as Info Alert.
+     * Creates an Adaptable Alert based on given parameters and displays it as Info Alert.
      * @param alertHeader Header of the Alert (if shown in a popup its the Title of the Window)
      * @param alertMessage Main message of the alert
      */
-    showAlertInfo(alertHeader: string, alertMessage: string): void;
+    showAlertInfo(alertHeader: string, alertMessage: string): Promise<void>;
     /**
-     * Creates Alert formed from inputted values and displays it as Succcess Alert.
+     * Creates an Adaptable Alert based on given parameters and displays it as Succcess Alert.
      * @param alertHeader Header of the Alert (if shown in a popup its the Title of the Window)
      * @param alertMessage Main message of the alert
      */
-    showAlertSuccess(alertHeader: string, alertMessage: string): void;
+    showAlertSuccess(alertHeader: string, alertMessage: string): Promise<void>;
     /**
-     * Creates Alert formed from inputted values and displays it as Warning Alert.
+     * Creates an Adaptable Alert based on given parameters and displays it as Warning Alert.
      * @param alertHeader Header of the Alert (if shown in a popup its the Title of the Window)
      * @param alertMessage Main message of the alert
      */
-    showAlertWarning(alertHeader: string, alertMessage: string): void;
+    showAlertWarning(alertHeader: string, alertMessage: string): Promise<void>;
     /**
-     * Creates Alert formed from inputted values and displays it as Error Alert.
+     * Creates an Adaptable Alert based on given parameters and displays it as Error Alert.
      * @param alertHeader Header of the Alert (if shown in a popup its the Title of the Window)
      * @param alertMessage Main message of the alert
      */
-    showAlertError(alertHeader: string, alertMessage: string): void;
+    showAlertError(alertHeader: string, alertMessage: string): Promise<void>;
+    /****
+     * TO BE REMOVED
+     */
     /**
-     * Opens Settings Panel with Alert section selected and visible
+     * @deprecated use `openAlertSettingsPanel` instead
      */
     showAlertPopup(): void;
     /**
-     * Retrieves all Predicate Defs that match given Scope
-     * @param scope the Scope to check
+     * @deprecated use `showAdaptableAlert()` instead
      */
-    getAlertPredicateDefsForScope(scope: AdaptableScope): AdaptablePredicateDef[];
+    displayAlert(alert: AdaptableAlert): Promise<void>;
     /**
-     * Edits Alert in State with given one
-     * @param alertDefinition Alert to Edit
-     * @returns alert definition
+     * @deprecated internal method, will be removed in next major release
      */
-    editAlertDefinition(alertDefinition: AlertDefinition): AlertDefinition;
+    getNonReactiveAlertDefinitions(): AlertDefinition[];
     /**
-     * Suspends Alert Definition
-     * @param alertDefinition Alert to suspend
-     *
+     * @deprecated internal method, will be removed in next major release
      */
-    suspendAlertDefinition(alertDefinition: AlertDefinition): AlertDefinition;
+    getActiveNonReactiveAlertDefinitions(): AlertDefinition[];
     /**
-     * Activates a suspended Alert Definition
-     * @param alertDefinition - Alert to Un-suspend (activate)
-     * @returns alert definition
+     * @deprecated internal method, will be removed in next major release
      */
-    unSuspendAlertDefinition(alertDefinition: AlertDefinition): AlertDefinition;
+    getReactiveAlertDefinitions(): AlertDefinition[];
     /**
-     * Returns a description of an Alert Definition
-     * @param alertDefinition Alert Definition to use
+     * @deprecated internal method, will be removed in next major release
+     */
+    getActiveReactiveAlertDefinitions(): AlertDefinition[];
+    /**
+     * @deprecated internal method, will be removed in next major release
+     */
+    getAlertDefinitionsWithPreventEdit(): AlertDefinition[];
+    /**
+     * @deprecated internal method, will be removed in next major release
+     */
+    getAlertDefinitionsWithAllowEdit(): AlertDefinition[];
+    /**
+     * @deprecated internal method, will be removed in next major release
+     */
+    publishAlertFiredEvent(alertToFire: AdaptableAlert): void;
+    /**
+     * @deprecated internal method, will be removed in next major release
+     */
+    executeAlertButton(button: AlertButton<AlertFormContext>, context: AlertFormContext): void;
+    /**
+     * @deprecated internal method, will be removed in next major release
+     */
+    executeAlertAction(actionName: AdaptableAlertAction | string, details: {
+        alertDefinition: AlertDefinition;
+        cellDataChangedInfo?: CellDataChangedInfo;
+        gridDataChangedInfo?: GridDataChangedInfo;
+        formData?: AdaptableFormData;
+    }): void;
+    /**
+     * @deprecated internal method, will be removed in next major release
+     */
+    getAlertPredicateDefsForScope(scope: AdaptableScope): AdaptablePredicateDef[];
+    /**
+     * @deprecated internal method, will be removed in next major release
      */
     getAlertDescription(alertDefinition: AlertDefinition, cellDataChangedInfo?: CellDataChangedInfo): string;
     /**
-     * Returns a description title of an Alert Definition
-     * @param alertDefinition Alert Definition to use
+     * @deprecated internal method, will be removed in next major release
      */
     getAlertMessageTitle(alertDefinition: AlertDefinition, cellDataChangedInfo?: CellDataChangedInfo): string;
     /**
-     * Returns a description of an Alert Definition's Rule
-     * @param alertDefinition Alert Definition to use
+     * @deprecated internal method, will be removed in next major release
      */
-    getAlertRuleDescription(alertDefinition: AlertDefinition): string;
+    getCustomAlertDescription(alertDefinition: AlertDefinition, dataChangedInfo?: {
+        cellDataChangedInfo?: CellDataChangedInfo;
+        gridDataChangedInfo?: GridDataChangedInfo;
+    }): string;
     /**
-     * Was Adaptable Alert fired due to a Cell Change
-     * @param alert AdaptableAlert to check
+     * @deprecated internal method, will be removed in next major release
+     */
+    getCustomAlertMessageTitle(alertDefinition: AlertDefinition, dataChangedInfo?: {
+        cellDataChangedInfo?: CellDataChangedInfo;
+        gridDataChangedInfo?: GridDataChangedInfo;
+    }): string;
+    /**
+     * @deprecated internal method, will be removed in next major release
+     */
+    getAlertRuleDescription(alertDefinition: AlertDefinition): string;
+    /***
+     * @deprecated internal method, will be removed in next major release
      */
     isCellChangedAdaptableAlert(alert: AdaptableAlert): boolean;
     /**
-     * Was Adaptable Alert fired due to a Row Change
-     * @param alert AdaptableAlert to check
+     * @deprecated internal method, will be removed in next major release
      */
     isRowChangedAdaptableAlert(alert: AdaptableAlert): boolean;
     /**
-     * Is Adaptable Alert a Generic one
-     * @param alert AdaptableAlert to check
+     * @deprecated internal method, will be removed in next major release
      */
     isGenericAdaptableAlert(alert: AdaptableAlert): boolean;
     /**
-     * Returns for the Alert Type for an Adaptable Alert
-     * @param alert AdaptableAlert to check
+     * @deprecated internal method, will be removed in next major release
      */
     getAlertTypeForAdaptableAlert(alert: AdaptableAlert): 'cellChanged' | 'rowChanged' | 'generic';
 }

package/src/Api/BulkUpdateApi.d.ts

@@ -8,9 +8,9 @@ export interface BulkUpdateApi {
      */
     getBulkUpdateValue(): string;
     /**
-     * Opens Settings Panel with Bulk Update section selected and visible
+     * Opens Bulk Update Settings Panel
      */
-    showBulkUpdatePopup(): void;
+    openBulkUpdateSettingsPanel(): void;
     /**
      * Applies a Bulk Update to given Cells
      * @param gridCells Cells to apply the Bulk Update
@@ -21,4 +21,11 @@ export interface BulkUpdateApi {
      * @param bulkUpdateValue the value to use in Bulk Update Operation
      */
     setBulkUpdateValue(bulkUpdateValue: string): void;
+    /**
+     * TO BE REMOVED
+     */
+    /**
+     * @deprecated use `openBulkUpdateSettingsPanel` instead
+     */
+    showBulkUpdatePopup(): void;
 }

package/src/Api/CalculatedColumnApi.d.ts

@@ -1,4 +1,4 @@
-import { CalculatedColumnState, CalculatedColumn } from '../PredefinedConfig/CalculatedColumnState';
+import { CalculatedColumn, CalculatedColumnState } from '../PredefinedConfig/CalculatedColumnState';
 /**
  * Provides run-time access to the Calculated Column Module
  **/
@@ -10,9 +10,9 @@ export interface CalculatedColumnApi {
     /**
      * Retrieves all Calculated Columns in Adaptable State
      */
-    getAllCalculatedColumn(): CalculatedColumn[];
+    getCalculatedColumns(): CalculatedColumn[];
     /**
-     * Retrieves Calculated Column by the unique identifier of the Adaptable Object in the CalculatedColumnState
+     * Retrieves Calculated Column by the technical ID (from `CalculatedColumnState`)
      * @param id - Calculated Column state unique identifier
      * @returns calculated column
      */
@@ -30,45 +30,50 @@ export interface CalculatedColumnApi {
      */
     addCalculatedColumn(calcColumn: CalculatedColumn): CalculatedColumn;
     /**
-     * Edits given Calculated Column
+     * Updates given Calculated Column in Adaptable State
      * @param calcColumn Calculated Column to edit
      * @returns calculated column
      */
     editCalculatedColumn(calcColumn: CalculatedColumn): CalculatedColumn;
     /**
-     * Edits given Calculated Columns
-     * @param calcColumns Calculated Columns to edit
-     * @returns calculated columns
-     */
-    editCalculatedColumns(calcColumns: CalculatedColumn[]): CalculatedColumn[];
-    /**
-     * Removes Calculated Column from State
+     * Deletes Calculated Column with given ColumnId from Adaptable State
      *
-     * @param calcColumn Calculated Column to delete
+     * @param columnId ColumnId of Calculated Column to delete
      */
-    deleteCalculatedColumn(calcColumn: string): void;
+    deleteCalculatedColumn(columnId: string): void;
     /**
      * Opens Settings Panel with Calculated Column section selected and visible
      */
+    openCalculatedColumnSettingsPanel(): void;
+    /**
+     * TO BE REMOVED
+     */
+    /**
+     * @deprecated use `openCalculatedColumnSettingsPanel` instead
+     */
     showCalculatedColumnPopup(): void;
     /**
-     * Returns all the references in the AdaptableState of the given CalculatedColumn
-     * @param calculatedColumn CalculatedColumn to be checked
+     * @deprecated use `getCalculatedColumns()` instead
+     */
+    getAllCalculatedColumn(): CalculatedColumn[];
+    /***
+     * @deprecated internal method, will be removed in next major release
+     */
+    editCalculatedColumns(calcColumns: CalculatedColumn[]): CalculatedColumn[];
+    /**
+     * @deprecated internal method, will be removed in next major release
      */
     getCalculatedColumnModuleReferences(calculatedColumn: CalculatedColumn): string[];
     /**
-     * Returns all Calculated Columns whose Expression contains the ColumnId
-     * @param columnId ColumnId to check
+     * @deprecated internal method, will be removed in next major release
      */
     getCalculatedColumnsReferencingColumnId(columnId: string): CalculatedColumn[];
     /**
-     * Gets any ColumnIds referenced in a Calculated Column
-     * @param calculatedColumn Calculated Column to check
+     * @deprecated internal method, will be removed in next major release
      */
     getReferencedColumnIdsForCalculatedColumn(calculatedColumn: CalculatedColumn): string[];
     /**
-     * Gets any ColumnIds referenced in a Calculated Column
-     * @param calculatedColumnId CalculatedColumnId to check
+     * @deprecated internal method, will be removed in next major release
      */
     getReferencedColumnIdsForCalculatedColumnId(calculatedColumnId: string): string[];
 }

package/src/Api/CellSummaryApi.d.ts

@@ -3,6 +3,10 @@ import { CellSummaryOperation } from '../PredefinedConfig/Common/CellSummary';
  *  Provides run-time access to the Cell Summary Module
  */
 export interface CellSummaryApi {
+    /**
+     * Retrieves all Cell Summary Definitions from Cell Summary State
+     */
+    getCellSummaryOperationDefinitions(): CellSummaryOperation[];
     /**
      * Retrieves currently selected Cell Summary Operation
      */
@@ -12,19 +16,22 @@ export interface CellSummaryApi {
      */
     setCurrentCellSummaryOperation(operation: CellSummaryOperation | string): void;
     /**
-     * Retrieves all Cell Summary Definitions from Cell Summary State
-     */
-    getCellSummaryOperationDefinitions(): CellSummaryOperation[];
-    /**
-     * Opens Settings Panel with Cell Summary section selected and visible
+     * Opens Cell Summary Settings Panel with
      */
-    showCellSummaryPopup(): void;
+    openCellSummaryPopupSettingsPanel(): void;
     /**
-     * Retrieves the value of the current selected operation
+     * Retrieves the value of the current selected Cell Summary Operation
      */
     getCurrentCellSummaryOperationValue(): number;
     /**
-     * Retrieves the value of the current selected operation
+     * Retrieves the value of the given Cell Summary Operation
      */
     getCellSummaryOperationValue(operation: CellSummaryOperation | string): any;
+    /**
+     * TO BE REMOVED
+     */
+    /**
+     * @deprecated use `openCellSummaryPopupSettingsPanel` instead
+     */
+    showCellSummaryPopup(): void;
 }

package/src/Api/ChartingApi.d.ts

@@ -19,14 +19,14 @@ export interface ChartingApi {
     /**
      * Retrieves all adaptable chart definitions
      */
-    getAllChartDefinitions(): ChartDefinition[];
+    getChartDefinitions(): ChartDefinition[];
     /**
      * Retrieves chart definition by uuid
      * @param uuid chart uuid
      */
     getChartDefinitionByUuid(uuid: string): ChartDefinition | undefined;
     /**
-     * Retrieves chartRef by chartId
+     * Retrieves AG Grid ChartRef for given chartId
      */
     getChartRef(chartId: string): ChartRef | undefined;
     /**
@@ -60,4 +60,11 @@ export interface ChartingApi {
      * @param chartDefinition
      */
     addChartDefinition(chartDefinition: ChartDefinition): void;
+    /**
+     * TO BE REMOVED
+     */
+    /**
+     * @deprecated use `getChartDefinitions()` instead
+     */
+    getAllChartDefinitions(): ChartDefinition[];
 }