@adaptabletools/adaptable 16.2.3 → 16.2.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adaptabletools/adaptable",
-  "version": "16.2.3",
+  "version": "16.2.4",
   "description": "Powerful data-agnostic HTML5 AG Grid extension which provides advanced, cutting-edge functionality to meet all DataGrid requirements",
   "keywords": [
     "web-components",

package/publishTimestamp.d.ts

@@ -1,2 +1,2 @@
-declare const _default: 1701111826846;
+declare const _default: 1701436913372;
 export default _default;

package/publishTimestamp.js

@@ -1,3 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = 1701111826846;
+exports.default = 1701436913372;

package/src/AdaptableOptions/PredicateOptions.d.ts

@@ -1,4 +1,4 @@
-import { AdaptablePredicateDef, AdaptableScope, BaseContext, PredicateModuleScope, SystemAlertPredicateIds, SystemBadgeStylePredicateIds, SystemFilterPredicateIds, SystemFlashingCellPredicateIds, SystemFormatColumnPredicateIds } from '../types';
+import { AdaptablePredicateDef, AdaptableScope, BaseContext, PredicateModuleScope, SystemAlertPredicateId, SystemAlertPredicateIds, SystemBadgeStylePredicateId, SystemBadgeStylePredicateIds, SystemFilterPredicateId, SystemFilterPredicateIds, SystemFlashingCellPredicateId, SystemFlashingCellPredicateIds, SystemFormatColumnPredicateId, SystemFormatColumnPredicateIds } from '../types';
 /**
  * Options for managing Adaptable Predicates using AdaptableQL
  */
@@ -10,23 +10,23 @@ export interface PredicateOptions {
     /**
      * Which System Filter Predicates are available
      */
-    systemFilterPredicates?: SystemFilterPredicateIds | ((context: SystemPredicatesContext) => SystemFilterPredicateIds);
+    systemFilterPredicates?: SystemFilterPredicateIds | ((context: SystemPredicatesContext<SystemFilterPredicateId>) => SystemFilterPredicateIds);
     /**
      * Which System Badge Style Predicates are available
      */
-    systemBadgeStylePredicates?: SystemBadgeStylePredicateIds | ((context: SystemPredicatesContext) => SystemBadgeStylePredicateIds);
+    systemBadgeStylePredicates?: SystemBadgeStylePredicateIds | ((context: SystemPredicatesContext<SystemBadgeStylePredicateId>) => SystemBadgeStylePredicateIds);
     /**
      * Which System Alert Predicates are available
      */
-    systemAlertPredicates?: SystemAlertPredicateIds | ((context: SystemPredicatesContext) => SystemAlertPredicateIds);
+    systemAlertPredicates?: SystemAlertPredicateIds | ((context: SystemPredicatesContext<SystemAlertPredicateId>) => SystemAlertPredicateIds);
     /**
      * Which System Format Column Predicates are available
      */
-    systemFormatColumnPredicates?: SystemFormatColumnPredicateIds | ((context: SystemPredicatesContext) => SystemFormatColumnPredicateIds);
+    systemFormatColumnPredicates?: SystemFormatColumnPredicateIds | ((context: SystemPredicatesContext<SystemFormatColumnPredicateId>) => SystemFormatColumnPredicateIds);
     /**
      * Which System Flashing Cell Predicates are available
      */
-    systemFlashingCellPredicates?: SystemFlashingCellPredicateIds | ((context: SystemPredicatesContext) => SystemFlashingCellPredicateIds);
+    systemFlashingCellPredicates?: SystemFlashingCellPredicateIds | ((context: SystemPredicatesContext<SystemFlashingCellPredicateId>) => SystemFlashingCellPredicateIds);
     /**
      * Perform case-sensitive text comparisons when evaluating Predicates
      *
@@ -39,11 +39,11 @@ export interface PredicateOptions {
 /**
  * Context used for setting which System Predicates are available
  */
-export interface SystemPredicatesContext extends BaseContext {
+export interface SystemPredicatesContext<PREDICATE_TYPE = string> extends BaseContext {
     /**
      * AdapTable-provided System Predicate Definitions
      */
-    systemPredicateDefs: AdaptablePredicateDef[];
+    systemPredicateDefs: AdaptablePredicateDef<PREDICATE_TYPE>[];
     /**
      * Module for which Predicates are being retrieved
      */

package/src/Api/Implementation/PredicateApiImpl.d.ts

@@ -1,15 +1,15 @@
 import { ApiBase } from './ApiBase';
 import { PredicateApi } from '../PredicateApi';
-import { PredicateDefHandlerContext, PredicateModuleScope } from '../../PredefinedConfig/Common/AdaptablePredicate';
-import { AdaptablePredicate, AdaptablePredicateDef, AdaptableColumnPredicate } from '../../types';
+import { AdaptableColumnPredicate, AdaptablePredicate, AdaptablePredicateDef, PredicateDefHandlerContext, PredicateModuleScope } from '../../types';
 import { IAdaptable } from '../../AdaptableInterfaces/IAdaptable';
 import { PredicateInternalApi } from '../Internal/PredicateInternalApi';
 export declare class PredicateApiImpl extends ApiBase implements PredicateApi {
     internalApi: PredicateInternalApi;
     constructor(adaptable: IAdaptable);
-    getPredicateDefs(): AdaptablePredicateDef[];
-    getSystemPredicateDefs(): AdaptablePredicateDef[];
-    getCustomPredicateDefs(): AdaptablePredicateDef[];
+    getPredicateDefs(): AdaptablePredicateDef<string>[];
+    getSystemPredicateDefs(): AdaptablePredicateDef<string>[];
+    getSystemPredicateDefsByModuleScope<PREDICATE_TYPE extends string = string>(moduleScope: PredicateModuleScope): AdaptablePredicateDef<PREDICATE_TYPE>[];
+    getCustomPredicateDefs(): AdaptablePredicateDef<string>[];
     getPredicateDefsByModuleScope(moduleScope: PredicateModuleScope): AdaptablePredicateDef[];
     getPredicateDefById(predicateId: string): AdaptablePredicateDef;
     getSystemPredicateDefById(predicateId: string): AdaptablePredicateDef;

package/src/Api/Implementation/PredicateApiImpl.js

@@ -3,21 +3,24 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.PredicateApiImpl = void 0;
 const tslib_1 = require("tslib");
 const ApiBase_1 = require("./ApiBase");
-const AdaptablePredicate_1 = require("../../PredefinedConfig/Common/AdaptablePredicate");
 const ArrayExtensions_1 = tslib_1.__importDefault(require("../../Utilities/Extensions/ArrayExtensions"));
 const StringExtensions_1 = tslib_1.__importDefault(require("../../Utilities/Extensions/StringExtensions"));
 const PredicateInternalApi_1 = require("../Internal/PredicateInternalApi");
+const AdaptablePredicate_1 = require("../../PredefinedConfig/Common/AdaptablePredicate");
 class PredicateApiImpl extends ApiBase_1.ApiBase {
     constructor(adaptable) {
         super(adaptable);
         this.internalApi = new PredicateInternalApi_1.PredicateInternalApi(adaptable);
     }
     getPredicateDefs() {
-        return [...this.getSystemPredicateDefs(), ...this.getCustomPredicateDefs()];
+        return this.internalApi.mergeSystemAndCustomPredicates(this.getSystemPredicateDefs(), this.getCustomPredicateDefs());
     }
     getSystemPredicateDefs() {
         return AdaptablePredicate_1.SystemPredicateDefs;
     }
+    getSystemPredicateDefsByModuleScope(moduleScope) {
+        return AdaptablePredicate_1.SystemPredicateDefs.filter((p) => p.moduleScope.includes(moduleScope));
+    }
     getCustomPredicateDefs() {
         return this.getPredicateOptions().customPredicateDefs;
     }
@@ -25,8 +28,7 @@ class PredicateApiImpl extends ApiBase_1.ApiBase {
         return this.getPredicateDefs().filter((p) => p.moduleScope.includes(moduleScope));
     }
     getPredicateDefById(predicateId) {
-        var _a;
-        return ((_a = this.getSystemPredicateDefById(predicateId)) !== null && _a !== void 0 ? _a : this.getCustomPredicateDefById(predicateId));
+        return this.getPredicateDefs().find((predicateDef) => predicateDef.id === predicateId);
     }
     getSystemPredicateDefById(predicateId) {
         return this.getSystemPredicateDefs().find((predicateDef) => predicateDef.id === predicateId);

package/src/Api/Internal/PredicateInternalApi.d.ts

@@ -40,4 +40,9 @@ export declare class PredicateInternalApi extends ApiBase {
      * Get all Badge Style Predicate Definitions - System and Custom
      */
     getBadgeStylePredicateDefs(scope: AdaptableScope): AdaptablePredicateDef[];
+    /**
+     * Merges System and Custom Predicate Definitions but ensures that Custom ones take precedence
+     * (i.e. if there is a Custom Predicate with the same Id as a System one, the Custom one is used)
+     */
+    mergeSystemAndCustomPredicates(systemDefs: AdaptablePredicateDef[], customDefs: AdaptablePredicateDef[]): AdaptablePredicateDef[];
 }

package/src/Api/Internal/PredicateInternalApi.js

@@ -16,10 +16,7 @@ class PredicateInternalApi extends ApiBase_1.ApiBase {
      */
     getFilterPredicateDefs(scope) {
         var _a;
-        return [
-            ...(_a = this.getSystemFilterPredicateIds(scope)) === null || _a === void 0 ? void 0 : _a.map((predicateId) => this.getPredicateApi().getPredicateDefById(predicateId)),
-            ...this.getPredicateApi().getCustomPredicateDefs(),
-        ].filter((predicateDef) => predicateDef.moduleScope.includes('filter'));
+        return this.mergeSystemAndCustomPredicates((_a = this.getSystemFilterPredicateIds(scope)) === null || _a === void 0 ? void 0 : _a.map((predicateId) => this.getPredicateApi().getPredicateDefById(predicateId)), this.getPredicateApi().getCustomPredicateDefs()).filter((predicateDef) => predicateDef.moduleScope.includes('filter'));
     }
     getSystemFilterPredicateIds(scope) {
         const systemFilterPredicates = this.getPredicateOptions().systemFilterPredicates;
@@ -28,9 +25,7 @@ class PredicateInternalApi extends ApiBase_1.ApiBase {
                 adaptableApi: this.adaptable.api,
                 userName: this.getOptions().userName,
                 adaptableId: this.getOptions().adaptableId,
-                systemPredicateDefs: this.getPredicateApi()
-                    .getSystemPredicateDefs()
-                    .filter((p) => p.moduleScope.includes('filter')),
+                systemPredicateDefs: this.getPredicateApi().getSystemPredicateDefsByModuleScope('filter'),
                 moduleScope: 'filter',
                 columnScope: scope,
             };
@@ -43,10 +38,7 @@ class PredicateInternalApi extends ApiBase_1.ApiBase {
      */
     getAlertPredicateDefs(scope) {
         var _a;
-        return [
-            ...(_a = this.getSystemAlertPredicateIds(scope)) === null || _a === void 0 ? void 0 : _a.map((predicateId) => this.getPredicateApi().getPredicateDefById(predicateId)),
-            ...this.getPredicateApi().getCustomPredicateDefs(),
-        ].filter((predicateDef) => predicateDef.moduleScope.includes('alert'));
+        return this.mergeSystemAndCustomPredicates((_a = this.getSystemAlertPredicateIds(scope)) === null || _a === void 0 ? void 0 : _a.map((predicateId) => this.getPredicateApi().getPredicateDefById(predicateId)), this.getPredicateApi().getCustomPredicateDefs()).filter((predicateDef) => predicateDef.moduleScope.includes('alert'));
     }
     getSystemAlertPredicateIds(scope) {
         const systemAlertPredicates = this.getPredicateOptions().systemAlertPredicates;
@@ -55,9 +47,7 @@ class PredicateInternalApi extends ApiBase_1.ApiBase {
                 adaptableApi: this.adaptable.api,
                 userName: this.getOptions().userName,
                 adaptableId: this.getOptions().adaptableId,
-                systemPredicateDefs: this.getPredicateApi()
-                    .getSystemPredicateDefs()
-                    .filter((p) => p.moduleScope.includes('alert')),
+                systemPredicateDefs: this.getPredicateApi().getSystemPredicateDefsByModuleScope('alert'),
                 moduleScope: 'alert',
                 columnScope: scope,
             };
@@ -72,9 +62,7 @@ class PredicateInternalApi extends ApiBase_1.ApiBase {
                 adaptableApi: this.adaptable.api,
                 userName: this.getOptions().userName,
                 adaptableId: this.getOptions().adaptableId,
-                systemPredicateDefs: this.getPredicateApi()
-                    .getSystemPredicateDefs()
-                    .filter((p) => p.moduleScope.includes('badgeStyle')),
+                systemPredicateDefs: this.getPredicateApi().getSystemPredicateDefsByModuleScope('badgeStyle'),
                 moduleScope: 'badgeStyle',
                 columnScope: scope,
             };
@@ -87,10 +75,7 @@ class PredicateInternalApi extends ApiBase_1.ApiBase {
      */
     getFormatColumnPredicateDefs(scope) {
         var _a;
-        return [
-            ...(_a = this.getSystemFormatColumnPredicateIds(scope)) === null || _a === void 0 ? void 0 : _a.map((predicateId) => this.getPredicateApi().getPredicateDefById(predicateId)),
-            ...this.getPredicateApi().getCustomPredicateDefs(),
-        ].filter((predicateDef) => predicateDef.moduleScope.includes('formatColumn'));
+        return this.mergeSystemAndCustomPredicates((_a = this.getSystemFormatColumnPredicateIds(scope)) === null || _a === void 0 ? void 0 : _a.map((predicateId) => this.getPredicateApi().getPredicateDefById(predicateId)), this.getPredicateApi().getCustomPredicateDefs()).filter((predicateDef) => predicateDef.moduleScope.includes('formatColumn'));
     }
     getSystemFormatColumnPredicateIds(scope) {
         const systemFormatColumnPredicates = this.getPredicateOptions().systemFormatColumnPredicates;
@@ -99,9 +84,7 @@ class PredicateInternalApi extends ApiBase_1.ApiBase {
                 adaptableApi: this.adaptable.api,
                 userName: this.getOptions().userName,
                 adaptableId: this.getOptions().adaptableId,
-                systemPredicateDefs: this.getPredicateApi()
-                    .getSystemPredicateDefs()
-                    .filter((p) => p.moduleScope.includes('formatColumn')),
+                systemPredicateDefs: this.getPredicateApi().getSystemPredicateDefsByModuleScope('formatColumn'),
                 moduleScope: 'formatColumn',
                 columnScope: scope,
             };
@@ -114,10 +97,7 @@ class PredicateInternalApi extends ApiBase_1.ApiBase {
      */
     getFlashingCellPredicateDefs(scope) {
         var _a;
-        return [
-            ...(_a = this.getSystemFlashingCellPredicateIds(scope)) === null || _a === void 0 ? void 0 : _a.map((predicateId) => this.getPredicateApi().getPredicateDefById(predicateId)),
-            ...this.getPredicateApi().getCustomPredicateDefs(),
-        ].filter((predicateDef) => predicateDef.moduleScope.includes('flashingcell'));
+        return this.mergeSystemAndCustomPredicates((_a = this.getSystemFlashingCellPredicateIds(scope)) === null || _a === void 0 ? void 0 : _a.map((predicateId) => this.getPredicateApi().getPredicateDefById(predicateId)), this.getPredicateApi().getCustomPredicateDefs()).filter((predicateDef) => predicateDef.moduleScope.includes('flashingcell'));
     }
     getSystemFlashingCellPredicateIds(scope) {
         const systemFlashingCellPredicates = this.getPredicateOptions().systemFlashingCellPredicates;
@@ -126,9 +106,7 @@ class PredicateInternalApi extends ApiBase_1.ApiBase {
                 adaptableApi: this.adaptable.api,
                 userName: this.getOptions().userName,
                 adaptableId: this.getOptions().adaptableId,
-                systemPredicateDefs: this.getPredicateApi()
-                    .getSystemPredicateDefs()
-                    .filter((p) => p.moduleScope.includes('flashingcell')),
+                systemPredicateDefs: this.getPredicateApi().getSystemPredicateDefsByModuleScope('flashingcell'),
                 moduleScope: 'flashingcell',
                 columnScope: scope,
             };
@@ -163,10 +141,19 @@ class PredicateInternalApi extends ApiBase_1.ApiBase {
      */
     getBadgeStylePredicateDefs(scope) {
         var _a;
-        return [
-            ...(_a = this.getSystemBadgeStylePredicateIds(scope)) === null || _a === void 0 ? void 0 : _a.map((predicateId) => this.getPredicateApi().getPredicateDefById(predicateId)),
-            ...this.getPredicateApi().getCustomPredicateDefs(),
-        ].filter((predicateDef) => predicateDef.moduleScope.includes('badgeStyle'));
+        return this.mergeSystemAndCustomPredicates((_a = this.getSystemBadgeStylePredicateIds(scope)) === null || _a === void 0 ? void 0 : _a.map((predicateId) => this.getPredicateApi().getPredicateDefById(predicateId)), this.getPredicateApi().getCustomPredicateDefs()).filter((predicateDef) => predicateDef.moduleScope.includes('badgeStyle'));
+    }
+    /**
+     * Merges System and Custom Predicate Definitions but ensures that Custom ones take precedence
+     * (i.e. if there is a Custom Predicate with the same Id as a System one, the Custom one is used)
+     */
+    mergeSystemAndCustomPredicates(systemDefs, customDefs) {
+        const systemDefsToUse = systemDefs.map((systemDef) => {
+            const customDef = customDefs.find((customDef) => customDef.id === systemDef.id);
+            return customDef ? customDef : systemDef;
+        });
+        const customDefsToUse = customDefs.filter((customDef) => !systemDefsToUse.find((systemDef) => systemDef.id === customDef.id));
+        return [...systemDefsToUse, ...customDefsToUse];
     }
 }
 exports.PredicateInternalApi = PredicateInternalApi;

package/src/Api/Internal/StyledColumnInternalApi.d.ts

@@ -58,7 +58,7 @@ export declare class StyledColumnInternalApi extends ApiBase {
      */
     hasStyledColumnRelativeCellRange(styledColumn: StyledColumn): boolean;
     getApplicableBadge(styledColumn: StyledColumn, context: PredicateDefHandlerContext): BadgeStyleDefinition | null;
-    getBadgePredicateDefsForColumn(columnId: string): import("../../types").AdaptablePredicateDef[];
+    getBadgePredicateDefsForColumn(columnId: string): import("../../types").AdaptablePredicateDef<string>[];
     getCheckBoxStyleStyledColumn(column: AdaptableColumn): StyledColumn | undefined;
     isCheckBoxStyleStyledColumn(column: AdaptableColumn): boolean;
     fireCheckboxColumnClickedEvent(columnId: string, rowData: any, primaryKeyValue: any, isChecked: boolean): void;

package/src/Api/PredicateApi.d.ts

@@ -12,6 +12,11 @@ export interface PredicateApi {
      * Returns Predicate Definitions provided by AdapTable
      */
     getSystemPredicateDefs(): AdaptablePredicateDef[];
+    /**
+     * Returns Predicate Definitions provided by AdapTable for given Module Scope
+     * @param moduleScope Module Scope to use
+     */
+    getSystemPredicateDefsByModuleScope<PREDICATE_TYPE extends string = string>(moduleScope: PredicateModuleScope): AdaptablePredicateDef<PREDICATE_TYPE>[];
     /**
      * Returns Predicate Definitions provided by users
      */

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

@@ -6,11 +6,11 @@ import { BaseContext } from './BaseContext';
 /**
  * Predicate object used by AdapTableQL - essentially a boolean function
  */
-export interface AdaptablePredicate {
+export interface AdaptablePredicate<PREDICATE_TYPE = string> {
     /**
      * Id of Predicate (e.g. `Equals`, `GreaterThan`)
      */
-    PredicateId: string;
+    PredicateId: PREDICATE_TYPE;
     /**
      * Optional Inputs that might be needed for evaluation
      */
@@ -28,11 +28,11 @@ export interface AdaptableColumnPredicate extends AdaptablePredicate {
 /**
  * Defines a Predicate - include where it can run and what it does
  */
-export interface AdaptablePredicateDef {
+export interface AdaptablePredicateDef<PREDICATE_TYPE = string> {
     /**
-     * Unique Id for the object
+     * Predicate Id
      */
-    id: string;
+    id: PREDICATE_TYPE;
     /**
      * Name of the Predicate
      */

package/src/View/Alert/Utilities/getAvailablePredicates.d.ts

@@ -1,3 +1,3 @@
 import { AdaptableApi, AdaptablePredicateDef, AdaptableScope } from '../../../types';
 import { AlertType } from './getAlertType';
-export declare const getAvailablePredicateDefinitions: (api: AdaptableApi, scope: AdaptableScope, alertType: AlertType) => AdaptablePredicateDef[];
+export declare const getAvailablePredicateDefinitions: (api: AdaptableApi, scope: AdaptableScope, alertType: AlertType) => AdaptablePredicateDef<string>[];