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

package/src/AdaptableOptions/UserInterfaceOptions.d.ts

@@ -60,7 +60,7 @@ export interface UserInterfaceOptions {
      */
     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)
+     * Optional list of CSS styles that can be used when creating Adaptable Styles in Adaptable (e.g. in Format Column and other Modules)
      *
      * @gridInfoItem
      */
@@ -79,7 +79,7 @@ export interface UserInterfaceOptions {
     /**
      * Which sections to show in the Grid Info Screen
      *
-     * @defaultValue ['GridSummary', 'AdaptableOptions', 'ColumnInfo']
+     * @defaultValue ['GridSummary', 'AdaptableOptions', 'ColumnInfo', 'AdaptableObjectsSummary']
      */
     gridInfoSections?: GridInfoSections;
     /**
@@ -193,7 +193,7 @@ export interface ObjectTagsContext extends BaseContext {
 /**
  * Provides Custom Display Formats
  */
-export declare type CustomDisplayFormatter = {
+export interface CustomDisplayFormatter {
     /**
      * Id of the Formatted
      */
@@ -210,7 +210,7 @@ export declare type CustomDisplayFormatter = {
      * Where the Custom Display Format can be applied
      */
     scope: AdaptableScope;
-};
+}
 /**
  * Context used in handler of CustomDisplayFormatter
  */

package/src/Api/ActionApi.d.ts

@@ -1,12 +1,16 @@
-import { ActionColumn } from '../../types';
+import { ActionColumn, ActionRowButtonType } from '../../types';
 /**
  * A large range of column-related functions in AdapTable
  */
 export interface ActionApi {
     /**
-     * Retrieves any Action Columns (provided in User Interface Options)
+     * Retrieves the Action Columns provided in Action Options
      */
-    getAllActionColumn(): ActionColumn[];
+    getActionColumns(): ActionColumn[];
+    /**
+     * Retrieves the Action Row Buttons provided in Action Options
+     */
+    getActionRowButtons(): ActionRowButtonType[];
     /**
      * Open edit dialog for row with the given primary key value
      * @param primaryKey - the primary key of the edited row
@@ -21,4 +25,11 @@ export interface ActionApi {
      * @param clonedRowNodePrimaryKey - the primary key of the duplicated row
      */
     displayCloneActionRow(clonedRowNodePrimaryKey?: any): void;
+    /**
+     * TO BE REMOVED
+     */
+    /**
+     * @deprecated use `getActionColumns()` instead
+     */
+    getAllActionColumn(): ActionColumn[];
 }

package/src/Api/AdaptableApi.d.ts

@@ -1,16 +1,17 @@
 import { AlertApi } from './AlertApi';
 import { PluginsApi } from './PluginsApi';
 import { BulkUpdateApi } from './BulkUpdateApi';
+import { CalendarApi } from './CalendarApi';
 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 { DataSetApi } from './DataSetApi';
 import { EventApi } from './EventApi';
 import { ExportApi } from './ExportApi';
+import { EntitlementApi } from './EntitlementApi';
 import { FormatColumnApi } from './FormatColumnApi';
 import { FreeTextColumnApi } from './FreeTextColumnApi';
 import { LayoutApi } from './LayoutApi';
@@ -22,7 +23,6 @@ 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';
@@ -38,6 +38,8 @@ import { FlashingCellApi } from './FlashingCellApi';
 import { ChartingApi } from './ChartingApi';
 import { SettingsPanelApi } from './SettingsPanelApi';
 import { StatusBarApi } from './StatusBarApi';
+import { StyledColumnApi } from './StyledColumnApi';
+import { OptionsApi } from './OptionsApi';
 /**
  *
  * The `AdaptableApi` provides developers with run-time access to AdapTable.
@@ -45,6 +47,10 @@ import { StatusBarApi } from './StatusBarApi';
  * Has a huge number of classes each dedicated to a specific AdapTable Module or functionality
  */
 export interface AdaptableApi {
+    /**
+     * Provides access to the Adaptable Options
+     */
+    optionsApi: OptionsApi;
     /**
      * Provides access to Action Rows and Columns
      */
@@ -61,6 +67,10 @@ export interface AdaptableApi {
      * Provides access to the Bulk Update Module
      */
     bulkUpdateApi: BulkUpdateApi;
+    /**
+     * Functions for managing Holidays
+     */
+    calendarApi: CalendarApi;
     /**
      * Provides access to the Calculated Column Module
      */
@@ -73,10 +83,6 @@ export interface AdaptableApi {
      * Provides a number of column-related methods
      */
     columnApi: ColumnApi;
-    /**
-     * Provides access to the Conditional Style Module
-     */
-    conditionalStyleApi: ConditionalStyleApi;
     /**
      * Methods giving access to Adaptable State
      */
@@ -97,6 +103,10 @@ export interface AdaptableApi {
      * Provides access to Data Sets
      */
     dataSetApi: DataSetApi;
+    /**
+     * Functions for managing Entitlements and Permissions
+     */
+    entitlementApi: EntitlementApi;
     /**
      * Used for listenning / subscribing to the various Events published by AdapTable
      */
@@ -146,7 +156,7 @@ export interface AdaptableApi {
      */
     queryApi: QueryApi;
     /**
-     * Mangages AdapTableQL (Query Language)
+     * Manages AdapTableQL (Query Language)
      */
     queryLanguageApi: QueryLanguageApi;
     /**
@@ -173,6 +183,10 @@ export interface AdaptableApi {
      * Provides access to the Smart Edit Module
      */
     smartEditApi: SmartEditApi;
+    /**
+     * Provides access to the Styled Column Module
+     */
+    styledColumnApi: StyledColumnApi;
     /**
      * Methods related to displaying System Status and application health messages
      */
@@ -201,11 +215,6 @@ export interface AdaptableApi {
      * Provides run-time access to the AdapTable Status Bar
      */
     statusBarApi: StatusBarApi;
-    /**
-     * Api methods used *internally* within AdapTable.
-     * @internal
-     */
-    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.
      * This destroys the Adaptable instance.

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,148 +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;
+    showAdaptableAlert(alertToShow: AdaptableAlert): Promise<void>;
     /**
-     * Runs after a button in an Alert Form is clicked
-     */
-    executeAlertButton(button: AlertButton<AlertFormContext>, context: AlertFormContext): 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 with Module Scope of Alert
+     * @deprecated use `showAdaptableAlert()` instead
      */
-    getAlertPredicateDefs(): AdaptablePredicateDef[];
+    displayAlert(alert: AdaptableAlert): Promise<void>;
     /**
-     * Retrieves all Predicate Defs that match given Scope
-     * @param scope the Scope to check
+     * @deprecated internal method, will be removed in next major release
      */
-    getAlertPredicateDefsForScope(scope: AdaptableScope): AdaptablePredicateDef[];
+    getNonReactiveAlertDefinitions(): AlertDefinition[];
     /**
-     * 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;
+    getActiveNonReactiveAlertDefinitions(): AlertDefinition[];
     /**
-     * Suspends Alert Definition
-     * @param alertDefinition Alert to suspend
-     *
+     * @deprecated internal method, will be removed in next major release
      */
-    suspendAlertDefinition(alertDefinition: AlertDefinition): AlertDefinition;
+    getReactiveAlertDefinitions(): 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;
+    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;
     /**
-     * Returns a description of an Alert Definition
-     * @param alertDefinition Alert Definition to use
+     * @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 of an Alert Definition's Rule
-     * @param alertDefinition Alert Definition to use
+     * @deprecated internal method, will be removed in next major release
+     */
+    getAlertMessageTitle(alertDefinition: AlertDefinition, cellDataChangedInfo?: CellDataChangedInfo): string;
+    /**
+     * @deprecated internal method, will be removed in next major release
+     */
+    getCustomAlertDescription(alertDefinition: AlertDefinition, dataChangedInfo?: {
+        cellDataChangedInfo?: CellDataChangedInfo;
+        gridDataChangedInfo?: GridDataChangedInfo;
+    }): string;
+    /**
+     * @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;
+    /**
+     * @deprecated internal method, will be removed in next major release
+     */
+    isRowChangedAdaptableAlert(alert: AdaptableAlert): boolean;
+    /**
+     * @deprecated internal method, will be removed in next major release
+     */
+    isGenericAdaptableAlert(alert: AdaptableAlert): boolean;
+    /**
+     * @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/CalendarApi.d.ts

@@ -0,0 +1,29 @@
+/**
+ * Calendar, Holiday and Working Day related functions, using supplied Calendars in General Options
+ **/
+export interface CalendarApi {
+    /**
+     * Returns the next Working Day
+     */
+    getNextWorkingDay(): Date;
+    /**
+     * Returns the previous Working Day
+     */
+    getPreviousWorkingDay(): Date;
+    /**
+     * Checks if given date is a Working Day
+     * @param dateToCheck Date To Check
+     */
+    isWorkingDay(dateToCheck: Date): boolean;
+    /**
+     * Checks if given data is a Holiday
+     * @param dateToCheck Date to Check
+     */
+    isHoliday(dateToCheck: Date): boolean;
+    /**
+     * Returns true if both Dates are the same, ignoring the time portions
+     * @param date1 1st Date
+     * @param date2 2nd Date
+     */
+    isSameDay(date1: Date, date2: Date): boolean;
+}

package/src/Api/CalendarApi.js

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