@adaptabletools/adaptable 15.0.2 → 15.1.0-canary.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (116) hide show
  1. package/bundle.cjs.js +185 -181
  2. package/package.json +3 -3
  3. package/publishTimestamp.d.ts +1 -1
  4. package/publishTimestamp.js +1 -1
  5. package/src/AdaptableInterfaces/IAdaptable.d.ts +3 -1
  6. package/src/AdaptableOptions/FilterOptions.d.ts +7 -0
  7. package/src/AdaptableOptions/GeneralOptions.d.ts +4 -0
  8. package/src/AdaptableOptions/SearchOptions.d.ts +8 -0
  9. package/src/AdaptableOptions/TeamSharingOptions.d.ts +7 -0
  10. package/src/AdaptableOptions/UserInterfaceOptions.d.ts +5 -5
  11. package/src/Api/GridApi.d.ts +14 -6
  12. package/src/Api/Implementation/ActionApiImpl.js +3 -4
  13. package/src/Api/Implementation/AdaptableApiImpl.d.ts +4 -0
  14. package/src/Api/Implementation/AdaptableApiImpl.js +12 -0
  15. package/src/Api/Implementation/AlertApiImpl.js +23 -24
  16. package/src/Api/Implementation/ApiBase.d.ts +4 -0
  17. package/src/Api/Implementation/ApiBase.js +14 -3
  18. package/src/Api/Implementation/CalculatedColumnApiImpl.js +8 -9
  19. package/src/Api/Implementation/CellSummaryApiImpl.js +1 -1
  20. package/src/Api/Implementation/ChartingApiImpl.js +1 -1
  21. package/src/Api/Implementation/ColumnApiImpl.js +31 -32
  22. package/src/Api/Implementation/CustomSortApiImpl.js +5 -6
  23. package/src/Api/Implementation/DashboardApiImpl.js +3 -3
  24. package/src/Api/Implementation/DataChangeHistoryApiImpl.js +1 -1
  25. package/src/Api/Implementation/DataSetApiImpl.js +3 -3
  26. package/src/Api/Implementation/ExportApiImpl.js +7 -8
  27. package/src/Api/Implementation/FilterApiImpl.js +15 -16
  28. package/src/Api/Implementation/FlashingCellApiImpl.js +3 -3
  29. package/src/Api/Implementation/FormatColumnApiImpl.js +18 -18
  30. package/src/Api/Implementation/FreeTextColumnApiImpl.js +9 -10
  31. package/src/Api/Implementation/GridApiImpl.d.ts +7 -2
  32. package/src/Api/Implementation/GridApiImpl.js +52 -13
  33. package/src/Api/Implementation/LayoutApiImpl.js +11 -12
  34. package/src/Api/Implementation/PlusMinusApiImpl.js +1 -1
  35. package/src/Api/Implementation/PredicateApiImpl.js +8 -9
  36. package/src/Api/Implementation/QueryApiImpl.js +5 -5
  37. package/src/Api/Implementation/QueryLanguageApiImpl.js +5 -6
  38. package/src/Api/Implementation/QuickSearchApiImpl.js +1 -1
  39. package/src/Api/Implementation/ScheduleApiImpl.js +17 -17
  40. package/src/Api/Implementation/SettingsPanelApiImpl.js +3 -4
  41. package/src/Api/Implementation/ShortcutApiImpl.js +5 -5
  42. package/src/Api/Implementation/SmartEditApiImpl.js +1 -1
  43. package/src/Api/Implementation/StyledColumnApiImpl.js +4 -4
  44. package/src/Api/Implementation/SystemStatusApiImpl.js +2 -2
  45. package/src/Api/Implementation/TeamSharingApiImpl.js +11 -12
  46. package/src/Api/Implementation/ThemeApiImpl.js +4 -4
  47. package/src/Api/Implementation/UserInterfaceApiImpl.js +2 -2
  48. package/src/Api/Internal/AdaptableInternalApi.js +1 -2
  49. package/src/Api/Internal/ChartingInternalApi.js +1 -2
  50. package/src/Api/Internal/GridInternalApi.js +11 -1
  51. package/src/Api/Internal/QueryInternalApi.js +1 -2
  52. package/src/Redux/Store/AdaptableReduxLocalStorageEngine.js +4 -4
  53. package/src/Redux/Store/AdaptableReduxMerger.js +1 -2
  54. package/src/Redux/Store/AdaptableStore.js +16 -15
  55. package/src/Strategy/AlertModule.js +1 -0
  56. package/src/Strategy/CalculatedColumnModule.js +2 -3
  57. package/src/Strategy/CustomSortModule.d.ts +1 -0
  58. package/src/Strategy/CustomSortModule.js +1 -0
  59. package/src/Strategy/DashboardModule.js +1 -2
  60. package/src/Strategy/DataChangeHistoryModule.js +1 -2
  61. package/src/Strategy/FilterModule.js +1 -2
  62. package/src/Strategy/FlashingCellModule.js +1 -0
  63. package/src/Strategy/FormatColumnModule.js +2 -2
  64. package/src/Strategy/Interface/IModule.d.ts +6 -0
  65. package/src/Strategy/PlusMinusModule.js +1 -0
  66. package/src/Strategy/ScheduleModule.js +21 -0
  67. package/src/Strategy/ShortcutModule.js +1 -0
  68. package/src/Strategy/StyledColumnModule.js +2 -2
  69. package/src/Strategy/ToolPanelModule.js +2 -3
  70. package/src/Strategy/Utilities/Alert/getAlertBehaviourViewItems.d.ts +3 -8
  71. package/src/Strategy/Utilities/getObjectTagsViewItems.js +27 -2
  72. package/src/Utilities/Defaults/DefaultAdaptableOptions.js +3 -0
  73. package/src/Utilities/ExpressionFunctions/booleanExpressionFunctions.js +2 -2
  74. package/src/Utilities/ExpressionFunctions/scalarExpressionFunctions.d.ts +1 -1
  75. package/src/Utilities/ExpressionFunctions/scalarExpressionFunctions.js +104 -42
  76. package/src/Utilities/Extensions/NumberExtensions.d.ts +2 -0
  77. package/src/Utilities/Extensions/NumberExtensions.js +6 -1
  78. package/src/Utilities/Helpers/AdaptableHelper.js +1 -2
  79. package/src/Utilities/Helpers/DateHelper.js +2 -2
  80. package/src/Utilities/Helpers/Helper.js +3 -3
  81. package/src/Utilities/Services/AggregatedScalarLiveValue.js +3 -4
  82. package/src/Utilities/Services/AlertService.js +1 -2
  83. package/src/Utilities/Services/CalculatedColumnExpressionService.js +3 -4
  84. package/src/Utilities/Services/DataService.js +1 -2
  85. package/src/Utilities/Services/LicenseService/index.js +1 -1
  86. package/src/Utilities/Services/MetamodelService.js +3 -4
  87. package/src/Utilities/Services/QueryLanguageService.js +1 -2
  88. package/src/Utilities/logDeprecation.d.ts +4 -3
  89. package/src/Utilities/logDeprecation.js +6 -7
  90. package/src/View/Charting/useChartState.js +1 -2
  91. package/src/View/Components/AdaptableObjectList/AdaptableObjectList.d.ts +1 -0
  92. package/src/View/Components/AdaptableObjectList/AdaptableObjectList.js +9 -2
  93. package/src/View/Dashboard/Dashboard.js +1 -2
  94. package/src/View/Layout/Wizard/sections/FilterSection.js +1 -1
  95. package/src/View/StateManagement/handleExportState.js +1 -2
  96. package/src/View/StyledColumn/Wizard/StyledColumnSparklineSettingsSection.js +1 -2
  97. package/src/View/TeamSharing/SharedEntityObjectView.d.ts +3 -0
  98. package/src/View/Theme/ThemePopup.d.ts +1 -1
  99. package/src/View/Theme/ThemePopup.js +17 -3
  100. package/src/agGrid/Adaptable.d.ts +3 -1
  101. package/src/agGrid/Adaptable.js +94 -50
  102. package/src/agGrid/AdaptableLogger.d.ts +26 -0
  103. package/src/agGrid/AdaptableLogger.js +148 -0
  104. package/src/agGrid/agGridHelper.js +7 -8
  105. package/src/components/ExpressionEditor/BaseEditorInput.js +1 -2
  106. package/src/components/OverlayTrigger/index.js +1 -2
  107. package/src/components/SelectableList/index.js +0 -2
  108. package/src/components/icons/index.js +2 -2
  109. package/src/metamodel/adaptable.metamodel.js +1 -1
  110. package/src/parser/src/evaluator.js +3 -1
  111. package/src/parser/src/parser.js +496 -453
  112. package/src/parser/src/types.d.ts +1 -1
  113. package/version.d.ts +1 -1
  114. package/version.js +1 -1
  115. package/src/Utilities/Helpers/LoggingHelper.d.ts +0 -15
  116. package/src/Utilities/Helpers/LoggingHelper.js +0 -111
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@adaptabletools/adaptable",
3
- "version": "15.0.2",
3
+ "version": "15.1.0-canary.0",
4
4
  "description": "Powerful data-agnostic HTML5 AG Grid extension which provides advanced, cutting-edge functionality to meet all DataGrid requirements",
5
5
  "keywords": [
6
6
  "web-components",
@@ -33,7 +33,7 @@
33
33
  "dependencies": {
34
34
  "@infinite-table/infinite-react": "1.0.0",
35
35
  "date-fns": "^2.28.0",
36
- "debug": "^4.3.1",
36
+ "debug": "4.3.4",
37
37
  "isomorphic-fetch": "^2.2.1",
38
38
  "lodash": "^4.17.15",
39
39
  "normalize.css": "^8.0.1",
@@ -56,6 +56,6 @@
56
56
  "uuid": "^3.3.2"
57
57
  },
58
58
  "peerDependencies": {
59
- "@ag-grid-community/core": ">=29.0.0"
59
+ "@ag-grid-community/core": ">=29.1.0"
60
60
  }
61
61
  }
@@ -1,2 +1,2 @@
1
- declare const _default: 1677769748348;
1
+ declare const _default: 1680538758496;
2
2
  export default _default;
@@ -1,3 +1,3 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.default = 1677769748348;
3
+ exports.default = 1680538758496;
@@ -28,6 +28,7 @@ import { IMetamodelService } from '../Utilities/Services/Interface/IMetamodelSer
28
28
  import { ColumnValuesComparer } from '../AdaptableOptions/GeneralOptions';
29
29
  import { IRowEditService } from '../Utilities/Services/Interface/IRowEditService';
30
30
  import { RenderReactRootFn } from '../renderReactRoot';
31
+ import { AdaptableLogger } from '../agGrid/AdaptableLogger';
31
32
  export declare type AdaptableVariant = 'vanilla' | 'react' | 'angular';
32
33
  /**
33
34
  * The only interface for Adaptable
@@ -37,6 +38,7 @@ export declare type AdaptableVariant = 'vanilla' | 'react' | 'angular';
37
38
  * Should only be used internally as all external access is via the Api
38
39
  */
39
40
  export interface IAdaptable {
41
+ logger: AdaptableLogger;
40
42
  variant: AdaptableVariant;
41
43
  supressReact18RenderWarning: boolean;
42
44
  renderReactRoot: RenderReactRootFn;
@@ -139,7 +141,6 @@ export interface IAdaptable {
139
141
  setDataSource(dataSource: any): void;
140
142
  getGridData(): any[];
141
143
  getFilteredData(): any[];
142
- loadDataSource(dataSource: any): void;
143
144
  updateRows(dataRows: any[], dataUpdateConfig?: DataUpdateConfig): Promise<IRowNode[]>;
144
145
  addRows(dataRows: any[], dataUpdateConfig?: DataUpdateConfig): Promise<IRowNode[]>;
145
146
  deleteRows(dataRows: any[], dataUpdateConfig?: DataUpdateConfig): Promise<IRowNode[]>;
@@ -175,6 +176,7 @@ export interface IAdaptable {
175
176
  getDisplayValueFromRowNode(rowNode: IRowNode, columnId: string): string | undefined;
176
177
  getDisplayValueFromRawValue(rowNode: IRowNode, columnId: string, rawValue: any): string | undefined;
177
178
  getNormalisedValueFromRawValue(rawValue: any, column: AdaptableColumn): string | number | boolean | Date | unknown;
179
+ getGridCellsForColumn(columnId: string): GridCell[] | undefined;
178
180
  getDataRowFromRowNode(rowNode: IRowNode): any;
179
181
  getRowNodesForPrimaryKeys(primaryKeyValues: any[]): IRowNode[];
180
182
  getRowNodeForPrimaryKey(primaryKeyValue: any): IRowNode;
@@ -186,4 +186,11 @@ export interface FilterOptions<TData = any> {
186
186
  * @defaultValue 250
187
187
  */
188
188
  quickFilterDebounce?: number;
189
+ /**
190
+ * Show the count of each distinct item for given column in the Values (IN) Filter
191
+ * @defaultValue false
192
+ * @gridInfoItem
193
+ * @noCodeItem
194
+ */
195
+ showValuesCount?: (column: AdaptableColumn<TData>) => boolean;
189
196
  }
@@ -100,6 +100,10 @@ export interface DataSet extends AdaptableObject {
100
100
  * Params for Data Set popup form
101
101
  */
102
102
  form?: AdaptableForm<DataSetFormContext>;
103
+ /**
104
+ * Additional info for Data Set
105
+ */
106
+ info?: Record<string, string | number | boolean | Date>;
103
107
  }
104
108
  /**
105
109
  * Used when a DataSet displays a Form
@@ -31,4 +31,12 @@ export interface SearchOptions<TData = any> {
31
31
  * @noCodeItem
32
32
  */
33
33
  filterResultsAfterQuickSearch?: boolean;
34
+ /**
35
+ * Include Row Groups when Quick Searching (highlight only)
36
+ *
37
+ * @defaultValue false
38
+ * @gridInfoItem
39
+ * @noCodeItem
40
+ */
41
+ runQuickSearchOnRowGroups?: boolean;
34
42
  }
@@ -49,6 +49,13 @@ export interface TeamSharingOptions {
49
49
  * @gridInfoItem
50
50
  */
51
51
  updateNotification?: 'Alert' | 'AlertWithNotification' | 'SystemStatus';
52
+ /**
53
+ * Suppress warning when an Import overrides existing Config item
54
+ *
55
+ * @defaultValue false
56
+ * @gridInfoItem
57
+ */
58
+ suppressOverrideConfigWarning?: boolean;
52
59
  }
53
60
  /**
54
61
  * Context provided to `TeamSharingOptions.loadSharedEntities()` callback
@@ -28,7 +28,7 @@ export interface UserInterfaceOptions<TData = any> {
28
28
  */
29
29
  dateInputOptions?: DateInputOptions;
30
30
  /**
31
- * List of values which are permitted (e.g. to show in filter)
31
+ * List of values which are permitted (e.g. to show in Filter, Custom Sort etc.)
32
32
  */
33
33
  permittedValues?: PermittedValues<TData>[];
34
34
  /**
@@ -118,7 +118,7 @@ export interface EditLookUpPermittedValues<TData = any> extends BasePermittedVal
118
118
  values?: any[] | ((context: EditLookUpContext<TData>) => any[]);
119
119
  }
120
120
  /**
121
- * Used to define values inside the floating filter and floating filter (quick filter)
121
+ * Used to define values inside the Filter Bar and Filter Form
122
122
  */
123
123
  export interface FilterPermittedValues<TData = any> extends BasePermittedValues {
124
124
  /**
@@ -127,7 +127,7 @@ export interface FilterPermittedValues<TData = any> extends BasePermittedValues
127
127
  */
128
128
  suppressFilterSearchBar?: boolean;
129
129
  /**
130
- * Values to display in 'IN' Filter: either hardcoded list or a function that returns a list
130
+ * Function returning Values to display in 'IN' Filter - can be async
131
131
  */
132
132
  values: (context: FilterPermittedValuesContext<TData>) => any[] | Promise<any[]>;
133
133
  }
@@ -136,7 +136,7 @@ export interface FilterPermittedValues<TData = any> extends BasePermittedValues
136
136
  */
137
137
  export interface CustomSortPermittedValues<TData = any> extends BasePermittedValues {
138
138
  /**
139
- * Values to display in Custom Sort Wizard: either hardcoded list or a function that returns a list
139
+ * Function returning Values to display in Custom Sort Wizard - can be async
140
140
  */
141
141
  values: (context: PermittedValuesContext<TData>) => any[] | Promise<any[]>;
142
142
  }
@@ -145,7 +145,7 @@ export interface CustomSortPermittedValues<TData = any> extends BasePermittedVal
145
145
  */
146
146
  export interface BulkUpdatePermittedValues<TData = any> extends BasePermittedValues {
147
147
  /**
148
- * Values to display in Bulk Update Wizard: either hardcoded list or a function that returns a list
148
+ * Function returning Values to display in Bulk Update Wizard - can be async
149
149
  */
150
150
  values: (context: BulkUpdatePermittedValuesContext<TData>) => any[] | Promise<any[]>;
151
151
  }
@@ -20,11 +20,6 @@ export interface GridApi {
20
20
  * Returns Grid section from Adaptable State
21
21
  */
22
22
  getGridState(): GridState;
23
- /**
24
- * Repopulates grid with given data
25
- * @param data any data from any datasource that is suitable for AG Grid
26
- */
27
- setGridData(data: any[]): void;
28
23
  /**
29
24
  * Retrieves all data from the grid
30
25
  */
@@ -34,9 +29,18 @@ export interface GridApi {
34
29
  */
35
30
  getFilteredData(): any[];
36
31
  /**
37
- * Loads grid with given data
32
+ * Repopulates grid with given data and fires a 'GridDataChanged' event.
33
+ * @param data any data from any datasource that is suitable for AG Grid
34
+ */
35
+ setGridData(data: any[]): void;
36
+ /**
37
+ * Sets the grid with the given data. It does NOT fire a 'GridDataChanged' event.
38
38
  * @param data any data from any datasource that is suitable for AG Grid
39
39
  */
40
+ setInitialGridData(data: any): void;
41
+ /**
42
+ * @deprecated
43
+ */
40
44
  loadGridData(data: any): void;
41
45
  /**
42
46
  * Updates Adaptable (and AG Grid) with rows that have changed
@@ -272,6 +276,10 @@ export interface GridApi {
272
276
  * @param columnId ColumnId to lookup
273
277
  */
274
278
  getRawValueFromRowNode(rowNode: IRowNode, columnId: string): any | undefined;
279
+ getGridCellsForRawValue(columnId: string, rawValue: any): GridCell[] | undefined;
280
+ getCellRawValueCount(columnId: string, rawValue: any): number;
281
+ getGridCellsForDisplayValue(columnId: string, displayValue: any): GridCell[] | undefined;
282
+ getCellDisplayValueCount(columnId: string, displayValue: any): number;
275
283
  /**
276
284
  * Retrieves Formatted Value for a given Raw Value in given Column
277
285
  * @param columnId ColumnId to lookup
@@ -2,7 +2,6 @@
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.ActionApiImpl = void 0;
4
4
  const PopupRedux_1 = require("../../Redux/ActionsReducers/PopupRedux");
5
- const LoggingHelper_1 = require("../../Utilities/Helpers/LoggingHelper");
6
5
  const ApiBase_1 = require("./ApiBase");
7
6
  const ActionInternalApi_1 = require("../Internal/ActionInternalApi");
8
7
  const logDeprecation_1 = require("../../Utilities/logDeprecation");
@@ -26,7 +25,7 @@ class ActionApiImpl extends ApiBase_1.ApiBase {
26
25
  displayEditActionRow(primaryKey) {
27
26
  const rowNode = this.adaptable.api.gridApi.getRowNodeForPrimaryKey(primaryKey);
28
27
  if (!rowNode) {
29
- (0, LoggingHelper_1.LogAdaptableWarning)(`Can NOT edit row: rowNode not found for primaryKey ${primaryKey}`);
28
+ this.logWarn(`Can NOT edit row: rowNode not found for primaryKey ${primaryKey}`);
30
29
  }
31
30
  const editForm = this.internalApi.buildRowEditForm(rowNode);
32
31
  this.dispatchAction((0, PopupRedux_1.PopupShowForm)({
@@ -48,7 +47,7 @@ class ActionApiImpl extends ApiBase_1.ApiBase {
48
47
  displayCloneActionRow(primaryKey) {
49
48
  const rowNode = this.adaptable.api.gridApi.getRowNodeForPrimaryKey(primaryKey);
50
49
  if (!rowNode) {
51
- (0, LoggingHelper_1.LogAdaptableWarning)(`Can NOT clone row: rowNode not found for primaryKey ${primaryKey}`);
50
+ this.logWarn(`Can NOT clone row: rowNode not found for primaryKey ${primaryKey}`);
52
51
  }
53
52
  const createForm = this.internalApi.buildRowCreateForm(rowNode);
54
53
  this.dispatchAction((0, PopupRedux_1.PopupShowForm)({
@@ -61,7 +60,7 @@ class ActionApiImpl extends ApiBase_1.ApiBase {
61
60
  }));
62
61
  }
63
62
  getAllActionColumn() {
64
- (0, logDeprecation_1.logDeprecation)('ActionApi', 'getAllActionColumn', 'getActionColumns');
63
+ (0, logDeprecation_1.logDeprecation)(this.adaptable.logger, 'ActionApi', 'getAllActionColumn', 'getActionColumns');
65
64
  return this.getActionColumns();
66
65
  }
67
66
  }
@@ -97,4 +97,8 @@ export declare class AdaptableApiImpl implements AdaptableApi {
97
97
  destroyApi?: boolean;
98
98
  }): void;
99
99
  isDestroyed(): boolean;
100
+ logInfo(message: string, ...optionalParams: any[]): void;
101
+ logSuccess(message: string, ...optionalParams: any[]): void;
102
+ logWarn(message: string, ...optionalParams: any[]): void;
103
+ logError(message: string, ...optionalParams: any[]): void;
100
104
  }
@@ -149,5 +149,17 @@ class AdaptableApiImpl {
149
149
  isDestroyed() {
150
150
  return this.destroyed;
151
151
  }
152
+ logInfo(message, ...optionalParams) {
153
+ this.adaptable.logger.info(message, optionalParams);
154
+ }
155
+ logSuccess(message, ...optionalParams) {
156
+ this.adaptable.logger.success(message, optionalParams);
157
+ }
158
+ logWarn(message, ...optionalParams) {
159
+ this.adaptable.logger.warn(message, optionalParams);
160
+ }
161
+ logError(message, ...optionalParams) {
162
+ this.adaptable.logger.error(message, optionalParams);
163
+ }
152
164
  }
153
165
  exports.AdaptableApiImpl = AdaptableApiImpl;
@@ -6,7 +6,6 @@ const SystemRedux = tslib_1.__importStar(require("../../Redux/ActionsReducers/Sy
6
6
  const PopupRedux = tslib_1.__importStar(require("../../Redux/ActionsReducers/PopupRedux"));
7
7
  const AlertRedux = tslib_1.__importStar(require("../../Redux/ActionsReducers/AlertRedux"));
8
8
  const ApiBase_1 = require("./ApiBase");
9
- const LoggingHelper_1 = require("../../Utilities/Helpers/LoggingHelper");
10
9
  const ModuleConstants = tslib_1.__importStar(require("../../Utilities/Constants/ModuleConstants"));
11
10
  const ObjectFactory_1 = tslib_1.__importDefault(require("../../Utilities/ObjectFactory"));
12
11
  const AdaptableAlert_1 = require("../../PredefinedConfig/Common/AdaptableAlert");
@@ -43,7 +42,7 @@ class AlertApiImpl extends ApiBase_1.ApiBase {
43
42
  return this.getAlertDefinitionById(alertDefinition.Uuid);
44
43
  }
45
44
  async displayAlert(alertToShow) {
46
- (0, logDeprecation_1.logDeprecation)('AlertApi', 'displayAlert', 'showAdaptableAlert');
45
+ (0, logDeprecation_1.logDeprecation)(this.adaptable.logger, 'AlertApi', 'displayAlert', 'showAdaptableAlert');
47
46
  await this.showAdaptableAlert(alertToShow);
48
47
  }
49
48
  async showAdaptableAlert(alertToShow) {
@@ -72,7 +71,7 @@ class AlertApiImpl extends ApiBase_1.ApiBase {
72
71
  }
73
72
  // 2. Log to console
74
73
  if (alertProperties.LogToConsole) {
75
- (0, LoggingHelper_1.ConsoleLogByMessageType)(alertToShow.header + ': ' + alertToShow.message, alertDefinition.MessageType);
74
+ this.adaptable.logger.consoleLogByMessageType(alertToShow.header + ': ' + alertToShow.message, alertDefinition.MessageType);
76
75
  }
77
76
  // 3. Show it in a Div (if one has been set)
78
77
  if (alertProperties.ShowInDiv) {
@@ -139,7 +138,7 @@ class AlertApiImpl extends ApiBase_1.ApiBase {
139
138
  }
140
139
  }
141
140
  displayMessageAlertPopup(alertToDisplayAsPopup) {
142
- (0, logDeprecation_1.logDeprecation)('AlertApi', 'displayMessageAlertPopup', 'showAdaptableAlertAsToast');
141
+ (0, logDeprecation_1.logDeprecation)(this.adaptable.logger, 'AlertApi', 'displayMessageAlertPopup', 'showAdaptableAlertAsToast');
143
142
  this.showAdaptableAlertAsToast(alertToDisplayAsPopup);
144
143
  }
145
144
  showAdaptableAlertAsToast(alert) {
@@ -166,7 +165,7 @@ class AlertApiImpl extends ApiBase_1.ApiBase {
166
165
  this.showModulePopup(ModuleConstants.AlertModuleId);
167
166
  }
168
167
  showAlertPopup() {
169
- (0, logDeprecation_1.logDeprecation)('AlertApi', 'showAlertPopup', 'openAlertSettingsPanel');
168
+ (0, logDeprecation_1.logDeprecation)(this.adaptable.logger, 'AlertApi', 'showAlertPopup', 'openAlertSettingsPanel');
170
169
  this.openAlertSettingsPanel();
171
170
  }
172
171
  editAlertDefinition(alertDefinition) {
@@ -259,79 +258,79 @@ class AlertApiImpl extends ApiBase_1.ApiBase {
259
258
  * DEPRECATED INTERNAL METHODS
260
259
  */
261
260
  executeAlertAction(actionName, details) {
262
- (0, logDeprecation_1.logDeprecationInternal)('AlertApi', 'executeAlertAction');
261
+ (0, logDeprecation_1.logDeprecationInternal)(this.adaptable.logger, 'AlertApi', 'executeAlertAction');
263
262
  this.internalApi.executeAlertAction(actionName, details);
264
263
  }
265
264
  executeAlertButton(button, context) {
266
- (0, logDeprecation_1.logDeprecationInternal)('AlertApi', 'executeAlertButton');
265
+ (0, logDeprecation_1.logDeprecationInternal)(this.adaptable.logger, 'AlertApi', 'executeAlertButton');
267
266
  this.internalApi.executeAlertButton(button, context);
268
267
  }
269
268
  getActiveNonReactiveAlertDefinitions() {
270
- (0, logDeprecation_1.logDeprecationInternal)('AlertApi', 'getActiveNonReactiveAlertDefinitions');
269
+ (0, logDeprecation_1.logDeprecationInternal)(this.adaptable.logger, 'AlertApi', 'getActiveNonReactiveAlertDefinitions');
271
270
  return this.internalApi.getActiveNonReactiveAlertDefinitions();
272
271
  }
273
272
  getActiveReactiveAlertDefinitions() {
274
- (0, logDeprecation_1.logDeprecationInternal)('AlertApi', 'getActiveReactiveAlertDefinitions');
273
+ (0, logDeprecation_1.logDeprecationInternal)(this.adaptable.logger, 'AlertApi', 'getActiveReactiveAlertDefinitions');
275
274
  return this.internalApi.getActiveReactiveAlertDefinitions();
276
275
  }
277
276
  getAlertDefinitionsWithAllowEdit() {
278
- (0, logDeprecation_1.logDeprecationInternal)('AlertApi', 'getAlertDefinitionsWithAllowEdit');
277
+ (0, logDeprecation_1.logDeprecationInternal)(this.adaptable.logger, 'AlertApi', 'getAlertDefinitionsWithAllowEdit');
279
278
  return this.internalApi.getAlertDefinitionsWithAllowEdit();
280
279
  }
281
280
  getAlertDefinitionsWithPreventEdit() {
282
- (0, logDeprecation_1.logDeprecationInternal)('AlertApi', 'getAlertDefinitionsWithPreventEdit');
281
+ (0, logDeprecation_1.logDeprecationInternal)(this.adaptable.logger, 'AlertApi', 'getAlertDefinitionsWithPreventEdit');
283
282
  return this.internalApi.getAlertDefinitionsWithPreventEdit();
284
283
  }
285
284
  getAlertDescription(alertDefinition, cellDataChangedInfo) {
286
- (0, logDeprecation_1.logDeprecationInternal)('AlertApi', 'getAlertDescription');
285
+ (0, logDeprecation_1.logDeprecationInternal)(this.adaptable.logger, 'AlertApi', 'getAlertDescription');
287
286
  return this.internalApi.getAlertDescription(alertDefinition, cellDataChangedInfo);
288
287
  }
289
288
  getAlertMessageTitle(alertDefinition, cellDataChangedInfo) {
290
- (0, logDeprecation_1.logDeprecationInternal)('AlertApi', 'getAlertMessageTitle');
289
+ (0, logDeprecation_1.logDeprecationInternal)(this.adaptable.logger, 'AlertApi', 'getAlertMessageTitle');
291
290
  return this.internalApi.getAlertMessageTitle(alertDefinition, cellDataChangedInfo);
292
291
  }
293
292
  getAlertPredicateDefsForScope(scope) {
294
- (0, logDeprecation_1.logDeprecationInternal)('AlertApi', 'getAlertPredicateDefsForScope');
293
+ (0, logDeprecation_1.logDeprecationInternal)(this.adaptable.logger, 'AlertApi', 'getAlertPredicateDefsForScope');
295
294
  return this.internalApi.getAlertPredicateDefsForScope(scope);
296
295
  }
297
296
  getAlertRuleDescription(alertDefinition) {
298
- (0, logDeprecation_1.logDeprecationInternal)('AlertApi', 'getAlertRuleDescription');
297
+ (0, logDeprecation_1.logDeprecationInternal)(this.adaptable.logger, 'AlertApi', 'getAlertRuleDescription');
299
298
  return this.internalApi.getAlertRuleDescription(alertDefinition);
300
299
  }
301
300
  getAlertTypeForAdaptableAlert(alert) {
302
- (0, logDeprecation_1.logDeprecationInternal)('AlertApi', 'getAlertTypeForAdaptableAlert');
301
+ (0, logDeprecation_1.logDeprecationInternal)(this.adaptable.logger, 'AlertApi', 'getAlertTypeForAdaptableAlert');
303
302
  return this.internalApi.getAlertTypeForAdaptableAlert(alert);
304
303
  }
305
304
  getCustomAlertDescription(alertDefinition, dataChangedInfo) {
306
- (0, logDeprecation_1.logDeprecationInternal)('AlertApi', 'getCustomAlertDescription');
305
+ (0, logDeprecation_1.logDeprecationInternal)(this.adaptable.logger, 'AlertApi', 'getCustomAlertDescription');
307
306
  return this.internalApi.getCustomAlertDescription(alertDefinition, dataChangedInfo);
308
307
  }
309
308
  getCustomAlertMessageTitle(alertDefinition, dataChangedInfo) {
310
- (0, logDeprecation_1.logDeprecationInternal)('AlertApi', 'getCustomAlertMessageTitle');
309
+ (0, logDeprecation_1.logDeprecationInternal)(this.adaptable.logger, 'AlertApi', 'getCustomAlertMessageTitle');
311
310
  return this.internalApi.getCustomAlertMessageTitle(alertDefinition, dataChangedInfo);
312
311
  }
313
312
  getNonReactiveAlertDefinitions() {
314
- (0, logDeprecation_1.logDeprecationInternal)('AlertApi', 'getNonReactiveAlertDefinitions');
313
+ (0, logDeprecation_1.logDeprecationInternal)(this.adaptable.logger, 'AlertApi', 'getNonReactiveAlertDefinitions');
315
314
  return this.internalApi.getNonReactiveAlertDefinitions();
316
315
  }
317
316
  getReactiveAlertDefinitions() {
318
- (0, logDeprecation_1.logDeprecationInternal)('AlertApi', 'getReactiveAlertDefinitions');
317
+ (0, logDeprecation_1.logDeprecationInternal)(this.adaptable.logger, 'AlertApi', 'getReactiveAlertDefinitions');
319
318
  return this.internalApi.getReactiveAlertDefinitions();
320
319
  }
321
320
  isCellChangedAdaptableAlert(alert) {
322
- (0, logDeprecation_1.logDeprecationInternal)('AlertApi', 'isCellChangedAdaptableAlert');
321
+ (0, logDeprecation_1.logDeprecationInternal)(this.adaptable.logger, 'AlertApi', 'isCellChangedAdaptableAlert');
323
322
  return this.internalApi.isCellChangedAdaptableAlert(alert);
324
323
  }
325
324
  isGenericAdaptableAlert(alert) {
326
- (0, logDeprecation_1.logDeprecationInternal)('AlertApi', 'isGenericAdaptableAlert');
325
+ (0, logDeprecation_1.logDeprecationInternal)(this.adaptable.logger, 'AlertApi', 'isGenericAdaptableAlert');
327
326
  return this.internalApi.isGenericAdaptableAlert(alert);
328
327
  }
329
328
  isRowChangedAdaptableAlert(alert) {
330
- (0, logDeprecation_1.logDeprecationInternal)('AlertApi', 'isRowChangedAdaptableAlert');
329
+ (0, logDeprecation_1.logDeprecationInternal)(this.adaptable.logger, 'AlertApi', 'isRowChangedAdaptableAlert');
331
330
  return this.internalApi.isRowChangedAdaptableAlert(alert);
332
331
  }
333
332
  publishAlertFiredEvent(alertToFire) {
334
- (0, logDeprecation_1.logDeprecationInternal)('AlertApi', 'publishAlertFiredEvent');
333
+ (0, logDeprecation_1.logDeprecationInternal)(this.adaptable.logger, 'AlertApi', 'publishAlertFiredEvent');
335
334
  return this.internalApi.publishAlertFiredEvent(alertToFire);
336
335
  }
337
336
  }
@@ -22,6 +22,10 @@ export declare abstract class ApiBase {
22
22
  * @param adaptable the core IAdaptable object
23
23
  */
24
24
  constructor(adaptable: IAdaptable);
25
+ protected logInfo(message: string, ...optionalParams: any[]): void;
26
+ protected logSuccess(message: string, ...optionalParams: any[]): void;
27
+ protected logWarn(message: string, ...optionalParams: any[]): void;
28
+ protected logError(message: string, ...optionalParams: any[]): void;
25
29
  /**
26
30
  * Base api helper method which ensure that Adaptable Object being used in the function is not null or undefined
27
31
  *
@@ -2,7 +2,6 @@
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.ApiBase = void 0;
4
4
  const tslib_1 = require("tslib");
5
- const LoggingHelper_1 = require("../../Utilities/Helpers/LoggingHelper");
6
5
  const Helper_1 = tslib_1.__importDefault(require("../../Utilities/Helpers/Helper"));
7
6
  const Uuid_1 = require("../../PredefinedConfig/Uuid");
8
7
  // Base class for the Api - provides checking dispatching methods
@@ -14,6 +13,18 @@ class ApiBase {
14
13
  constructor(adaptable) {
15
14
  this.adaptable = adaptable;
16
15
  }
16
+ logInfo(message, ...optionalParams) {
17
+ this.adaptable.logger.info(message, ...optionalParams);
18
+ }
19
+ logSuccess(message, ...optionalParams) {
20
+ this.adaptable.logger.success(message, ...optionalParams);
21
+ }
22
+ logWarn(message, ...optionalParams) {
23
+ this.adaptable.logger.warn(message, ...optionalParams);
24
+ }
25
+ logError(message, ...optionalParams) {
26
+ this.adaptable.logger.error(message, ...optionalParams);
27
+ }
17
28
  /**
18
29
  * Base api helper method which ensure that Adaptable Object being used in the function is not null or undefined
19
30
  *
@@ -24,14 +35,14 @@ class ApiBase {
24
35
  */
25
36
  checkItemExists(item, name, type) {
26
37
  if (Helper_1.default.objectNotExists(item)) {
27
- (0, LoggingHelper_1.LogAdaptableError)(`No ${type} found with the name: ${name}`);
38
+ this.logError(`No ${type} found with the name: ${name}`);
28
39
  return false;
29
40
  }
30
41
  return true;
31
42
  }
32
43
  checkArrayExists(array) {
33
44
  if (!Array.isArray(array)) {
34
- (0, LoggingHelper_1.LogAdaptableError)(`Item passed to Api function was not an array`);
45
+ this.logError(`Item passed to Api function was not an array`);
35
46
  return false;
36
47
  }
37
48
  return true;
@@ -7,7 +7,6 @@ const ApiBase_1 = require("./ApiBase");
7
7
  const ModuleConstants = tslib_1.__importStar(require("../../Utilities/Constants/ModuleConstants"));
8
8
  const logDeprecation_1 = require("../../Utilities/logDeprecation");
9
9
  const CalculatedColumnInternalApi_1 = require("../Internal/CalculatedColumnInternalApi");
10
- const LoggingHelper_1 = require("../../Utilities/Helpers/LoggingHelper");
11
10
  class CalculatedColumnApiImpl extends ApiBase_1.ApiBase {
12
11
  constructor(adaptable) {
13
12
  super(adaptable);
@@ -21,7 +20,7 @@ class CalculatedColumnApiImpl extends ApiBase_1.ApiBase {
21
20
  return (_a = this.getCalculatedColumnState().CalculatedColumns) !== null && _a !== void 0 ? _a : [];
22
21
  }
23
22
  getAllCalculatedColumn() {
24
- (0, logDeprecation_1.logDeprecation)('CalculatedColumnApi', 'getAllCalculatedColumn', 'getCalculatedColumns');
23
+ (0, logDeprecation_1.logDeprecation)(this.adaptable.logger, 'CalculatedColumnApi', 'getAllCalculatedColumn', 'getCalculatedColumns');
25
24
  return this.getCalculatedColumns();
26
25
  }
27
26
  getCalculatedColumnById(id) {
@@ -40,7 +39,7 @@ class CalculatedColumnApiImpl extends ApiBase_1.ApiBase {
40
39
  return this.getCalculatedColumnById(calculatedColumn.Uuid);
41
40
  }
42
41
  editCalculatedColumns(calculatedColumns) {
43
- (0, logDeprecation_1.logDeprecationInternal)('CalculatedColumnApi', 'editCalculatedColumns');
42
+ (0, logDeprecation_1.logDeprecationInternal)(this.adaptable.logger, 'CalculatedColumnApi', 'editCalculatedColumns');
44
43
  calculatedColumns.forEach((cc) => {
45
44
  this.editCalculatedColumn(cc);
46
45
  });
@@ -68,7 +67,7 @@ class CalculatedColumnApiImpl extends ApiBase_1.ApiBase {
68
67
  var _a;
69
68
  const aggregatedCalculatedColumn = this.getCalculatedColumnForColumnId(columnId);
70
69
  if (!((_a = aggregatedCalculatedColumn === null || aggregatedCalculatedColumn === void 0 ? void 0 : aggregatedCalculatedColumn.Query) === null || _a === void 0 ? void 0 : _a.AggregatedScalarExpression)) {
71
- (0, LoggingHelper_1.LogAdaptableWarning)(`Aggregated calculated column with ID=${columnId} was NOT found (and refreshed)!`);
70
+ this.logWarn(`Aggregated calculated column with ID=${columnId} was NOT found (and refreshed)!`);
72
71
  return;
73
72
  }
74
73
  this.getAdaptableApi()
@@ -77,23 +76,23 @@ class CalculatedColumnApiImpl extends ApiBase_1.ApiBase {
77
76
  this.getGridApi().refreshCells(null, [columnId]);
78
77
  }
79
78
  showCalculatedColumnPopup() {
80
- (0, logDeprecation_1.logDeprecation)('CalculatedColumnApi', 'showCalculatedColumnPopup', 'openCalculatedColumnSettingsPanel');
79
+ (0, logDeprecation_1.logDeprecation)(this.adaptable.logger, 'CalculatedColumnApi', 'showCalculatedColumnPopup', 'openCalculatedColumnSettingsPanel');
81
80
  this.showModulePopup(ModuleConstants.CalculatedColumnModuleId);
82
81
  }
83
82
  getCalculatedColumnModuleReferences(calculatedColumn) {
84
- (0, logDeprecation_1.logDeprecationInternal)('CalculatedColumnApi', 'getCalculatedColumnModuleReferences');
83
+ (0, logDeprecation_1.logDeprecationInternal)(this.adaptable.logger, 'CalculatedColumnApi', 'getCalculatedColumnModuleReferences');
85
84
  return this.internalApi.getCalculatedColumnModuleReferences(calculatedColumn);
86
85
  }
87
86
  getCalculatedColumnsReferencingColumnId(columnId) {
88
- (0, logDeprecation_1.logDeprecationInternal)('CalculatedColumnApi', 'getCalculatedColumnsReferencingColumnId');
87
+ (0, logDeprecation_1.logDeprecationInternal)(this.adaptable.logger, 'CalculatedColumnApi', 'getCalculatedColumnsReferencingColumnId');
89
88
  return this.internalApi.getCalculatedColumnsReferencingColumnId(columnId);
90
89
  }
91
90
  getReferencedColumnIdsForCalculatedColumn(calculatedColumn) {
92
- (0, logDeprecation_1.logDeprecationInternal)('CalculatedColumnApi', 'getReferencedColumnIdsForCalculatedColumn');
91
+ (0, logDeprecation_1.logDeprecationInternal)(this.adaptable.logger, 'CalculatedColumnApi', 'getReferencedColumnIdsForCalculatedColumn');
93
92
  return this.internalApi.getReferencedColumnIdsForCalculatedColumn(calculatedColumn);
94
93
  }
95
94
  getReferencedColumnIdsForCalculatedColumnId(calculatedColumnId) {
96
- (0, logDeprecation_1.logDeprecationInternal)('CalculatedColumnApi', 'getReferencedColumnIdsForCalculatedColumnId');
95
+ (0, logDeprecation_1.logDeprecationInternal)(this.adaptable.logger, 'CalculatedColumnApi', 'getReferencedColumnIdsForCalculatedColumnId');
97
96
  return this.internalApi.getReferencedColumnIdsForCalculatedColumnId(calculatedColumnId);
98
97
  }
99
98
  }
@@ -27,7 +27,7 @@ class CellSummaryApiImpl extends ApiBase_1.ApiBase {
27
27
  return cellSummaryOperations;
28
28
  }
29
29
  showCellSummaryPopup() {
30
- (0, logDeprecation_1.logDeprecation)('CellSummaryApi', 'showCellSummaryPopup', 'openCellSummaryPopupSettingsPanel');
30
+ (0, logDeprecation_1.logDeprecation)(this.adaptable.logger, 'CellSummaryApi', 'showCellSummaryPopup', 'openCellSummaryPopupSettingsPanel');
31
31
  this.openCellSummaryPopupSettingsPanel();
32
32
  }
33
33
  setCurrentCellSummaryOperation(operation) {
@@ -39,7 +39,7 @@ class ChartingApiImpl extends ApiBase_1.ApiBase {
39
39
  return (_a = (0, ChartingRedux_1.ChartingGetChartModels)(this.getAdaptableState())) !== null && _a !== void 0 ? _a : [];
40
40
  }
41
41
  getAllChartDefinitions() {
42
- (0, logDeprecation_1.logDeprecation)('ChartingApi', 'getAllChartDefinitions', 'getChartDefinitions');
42
+ (0, logDeprecation_1.logDeprecation)(this.adaptable.logger, 'ChartingApi', 'getAllChartDefinitions', 'getChartDefinitions');
43
43
  return this.getChartDefinitions();
44
44
  }
45
45
  getChartDefinitionByUuid(uuid) {