@adaptabletools/adaptable 13.0.6 → 13.0.7

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.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@adaptabletools/adaptable",
3
- "version": "13.0.6",
3
+ "version": "13.0.7",
4
4
  "description": "Powerful data-agnostic HTML5 datagrid add-on that sits on top of an underlying grid component and provides all the rich functionality that advanced users expect from their DataGrids and Data Tables",
5
5
  "keywords": [
6
6
  "web-components",
@@ -1,2 +1,2 @@
1
- declare const _default: 1667290792339;
1
+ declare const _default: 1667316496830;
2
2
  export default _default;
@@ -1,3 +1,3 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.default = 1667290792339;
3
+ exports.default = 1667316496830;
@@ -1,7 +1,8 @@
1
1
  import { AdaptableColumn } from '../PredefinedConfig/Common/AdaptableColumn';
2
2
  import { FilterActionOnDataChange } from '../PredefinedConfig/Common/FilterActionOnDataChange';
3
- import { SystemFilterPredicateId, SystemFilterPredicateIds } from '../../types';
3
+ import { AdaptablePredicateDef, SystemFilterPredicateId, SystemFilterPredicateIds } from '../../types';
4
4
  import { StrictExtract } from '../Utilities/Extensions/TypeExtensions';
5
+ import { BaseContext } from '../types';
5
6
  /**
6
7
  * Options for managing Filtering in AdapTable
7
8
  */
@@ -148,9 +149,9 @@ export interface FilterOptions {
148
149
  */
149
150
  enableFilterOnSpecialColumns?: boolean;
150
151
  /**
151
- * Which Adaptable System Filter Predicates are available
152
+ * Set which System Filter Predicates are available, using list or function
152
153
  */
153
- systemFilters?: SystemFilterPredicateIds;
154
+ systemFilters?: SystemFilterPredicateIds | ((context: SystemFiltersPredicateContext) => SystemFilterPredicateIds);
154
155
  /**
155
156
  * Whether to display Quick Filter Bar between Column Header and the Grid (provided its been setup)
156
157
  * @defaultValue true
@@ -176,3 +177,12 @@ export interface FilterOptions {
176
177
  */
177
178
  showSuspendFilterButton?: boolean;
178
179
  }
180
+ /**
181
+ * Context used for providing System Filters
182
+ */
183
+ export interface SystemFiltersPredicateContext extends BaseContext {
184
+ /**
185
+ * AdapTable-provided System Filter Predicate Definitions
186
+ */
187
+ systemFiltersPredicateDefs: AdaptablePredicateDef[];
188
+ }
@@ -172,4 +172,24 @@ export interface AlertApi {
172
172
  * @param alertDefinition Alert Definition to use
173
173
  */
174
174
  getAlertRuleDescription(alertDefinition: AlertDefinition): string;
175
+ /**
176
+ * Was Adaptable Alert fired due to a Cell Change
177
+ * @param alert AdaptableAlert to check
178
+ */
179
+ isCellChangedAdaptableAlert(alert: AdaptableAlert): boolean;
180
+ /**
181
+ * Was Adaptable Alert fired due to a Row Change
182
+ * @param alert AdaptableAlert to check
183
+ */
184
+ isRowChangedAdaptableAlert(alert: AdaptableAlert): boolean;
185
+ /**
186
+ * Is Adaptable Alert a Generic one
187
+ * @param alert AdaptableAlert to check
188
+ */
189
+ isGenericAdaptableAlert(alert: AdaptableAlert): boolean;
190
+ /**
191
+ * Returns for the Alert Type for an Adaptable Alert
192
+ * @param alert AdaptableAlert to check
193
+ */
194
+ getAlertTypeForAdaptableAlert(alert: AdaptableAlert): 'cellChanged' | 'rowChanged' | 'generic';
175
195
  }
@@ -44,4 +44,8 @@ export declare class AlertApiImpl extends ApiBase implements AlertApi {
44
44
  unSuspendAlertDefinition(alertDefinition: AlertDefinition): AlertDefinition;
45
45
  getAlertDescription(alertDefinition: AlertDefinition, cellDataChangedInfo?: CellDataChangedInfo): string;
46
46
  getAlertRuleDescription(alert: AlertDefinition): string;
47
+ isCellChangedAdaptableAlert(alert: AdaptableAlert): boolean;
48
+ isRowChangedAdaptableAlert(alert: AdaptableAlert): boolean;
49
+ isGenericAdaptableAlert(alert: AdaptableAlert): boolean;
50
+ getAlertTypeForAdaptableAlert(alert: AdaptableAlert): 'cellChanged' | 'rowChanged' | 'generic';
47
51
  }
@@ -323,5 +323,17 @@ class AlertApiImpl extends ApiBase_1.ApiBase {
323
323
  : this.adaptable.api.internalApi.getAdaptableQueryExpressionText(alert.Rule);
324
324
  return ruleDescription;
325
325
  }
326
+ isCellChangedAdaptableAlert(alert) {
327
+ return alert.alertType === 'cellChanged';
328
+ }
329
+ isRowChangedAdaptableAlert(alert) {
330
+ return alert.alertType === 'rowChanged';
331
+ }
332
+ isGenericAdaptableAlert(alert) {
333
+ return alert.alertType === 'generic';
334
+ }
335
+ getAlertTypeForAdaptableAlert(alert) {
336
+ return alert.alertType;
337
+ }
326
338
  }
327
339
  exports.AlertApiImpl = AlertApiImpl;
@@ -275,7 +275,6 @@ class ColumnApiImpl extends ApiBase_1.ApiBase {
275
275
  return this.getColumns().filter((c) => c.queryable);
276
276
  }
277
277
  LogMissingColumnWarning(columnId) {
278
- console.log('MISSING', columnId);
279
278
  if (this.adaptable.adaptableOptions.columnOptions.showMissingColumnsWarning &&
280
279
  this.adaptable.adaptableOptions.columnOptions.showMissingColumnsWarning === true) {
281
280
  if (!this.isAutoRowGroupColumn(columnId) &&
@@ -10,7 +10,15 @@ const LoggingHelper_1 = require("../../Utilities/Helpers/LoggingHelper");
10
10
  const ArrayExtensions_1 = tslib_1.__importDefault(require("../../Utilities/Extensions/ArrayExtensions"));
11
11
  class FilterApiImpl extends ApiBase_1.ApiBase {
12
12
  getAllSystemFilterIds() {
13
- return this.getFilterOptions().systemFilters;
13
+ const systemFilters = this.getFilterOptions().systemFilters;
14
+ if (typeof systemFilters === 'function') {
15
+ const systemFiltersPredicateContext = {
16
+ adaptableApi: this.adaptable.api,
17
+ systemFiltersPredicateDefs: this.adaptable.api.predicateApi.getSystemPredicateDefs(),
18
+ };
19
+ return systemFilters(systemFiltersPredicateContext);
20
+ }
21
+ return systemFilters;
14
22
  }
15
23
  findPredicateDefByShortcut(shortcut, column) {
16
24
  return this.getFilterPredicateDefsForColumn(column).find((i) => { var _a; return (_a = i.shortcuts) === null || _a === void 0 ? void 0 : _a.includes(shortcut); });
@@ -2873,10 +2873,10 @@ export declare const ADAPTABLE_METAMODEL: {
2873
2873
  description: string;
2874
2874
  uiLabel: string;
2875
2875
  isOptional: boolean;
2876
- reference: string;
2877
2876
  gridInfo?: undefined;
2878
2877
  noCode?: undefined;
2879
2878
  defaultValue?: undefined;
2879
+ reference?: undefined;
2880
2880
  } | {
2881
2881
  name: string;
2882
2882
  kind: string;
@@ -4967,6 +4967,17 @@ export declare const ADAPTABLE_METAMODEL: {
4967
4967
  kind: string;
4968
4968
  description: string;
4969
4969
  };
4970
+ SystemFiltersPredicateContext: {
4971
+ name: string;
4972
+ kind: string;
4973
+ description: string;
4974
+ properties: {
4975
+ name: string;
4976
+ kind: string;
4977
+ description: string;
4978
+ uiLabel: string;
4979
+ }[];
4980
+ };
4970
4981
  SystemReportName: {
4971
4982
  name: string;
4972
4983
  kind: string;