npm - @adaptabletools/adaptable - Versions diffs - 16.2.3 → 17.0.0-canary.0 - Mend

@adaptabletools/adaptable 16.2.3 → 17.0.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 (1343) hide show

package/src/AdaptableOptions/ColumnFilterOptions.d.ts ADDED Viewed

@@ -0,0 +1,224 @@
+import { AdaptableColumn } from '../PredefinedConfig/Common/AdaptableColumn';
+import { FilterActionOnDataChange } from '../PredefinedConfig/Common/FilterActionOnDataChange';
+import { BaseContext, SystemAlertPredicateId, SystemFilterPredicateId } from '../../types';
+import { StrictExtract } from '../Utilities/Extensions/TypeExtensions';
+/**
+ * Options for managing Column Filtering in AdapTable
+ */
+export interface ColumnFilterOptions<TData = any> {
+    /**
+     * Hides Dropdown in Quick Filter Bar for a given Column
+     *
+     * @defaultValue undefined
+     */
+    hideQuickFilterDropdown?: (columFilterContext: ColumnFilterContext<TData>) => boolean;
+    /**
+     * Hides Input in Quick Filter Bar for a given Column
+     *
+     * @defaultValue undefined
+     */
+    hideQuickFilterInput?: (columFilterContext: ColumnFilterContext<TData>) => boolean;
+    /**
+     * Distinct column items to display in Filter Form; useful with large datasource (though AdapTable offers virtualisation)
+     *
+     * @defaultValue 2,000
+     * @gridInfoItem
+     * @noCodeItem
+     */
+    maxFilterValuesToDisplay?: number;
+    /**
+     * Make Column header distinctive for filtered columns, helps users see currently filtered columns
+     *
+     * @defaultValue true
+     * @gridInfoItem
+     * @noCodeItem
+     */
+    indicateFilteredColumns?: boolean;
+    /**
+     * Uses Adaptable's Filter Form in Column Menu for all columns if 'true' (the default) or those listed, in preference to AG Grid's Filter Form
+     *
+     * @defaultValue true
+     * @noCodeItem
+     */
+    useAdaptableFilterForm?: boolean | string[];
+    /**
+     * Styles Adaptable Filter Form to match AG Grid's styling (if using Balham theme)
+     *
+     * @defaultValue true
+     * @gridInfoItem
+     * @noCodeItem
+     */
+    useAgGridFilterFormStyle?: boolean;
+    /**
+     * Use Adaptable's Quick Filter Bar for all columns if 'true' (the default) or those listed, in preference to AG Grid's Floating Filter
+     *
+     * @defaultValue true
+     * @gridInfoItem
+     * @noCodeItem
+     */
+    useAdaptableQuickFilter?: boolean | string[];
+    /**
+     * Whether to open Quick Filter dropdown with mouse hover or click
+     *
+     * @defaultValue 'mouseenter'
+     * @gridInfoItem
+     * @noCodeItem
+     */
+    quickFilterTrigger?: 'mouseenter' | 'click';
+    /**
+     * Whether to open Quick Filter Values dropdown with mouse hover or click
+     *
+     * @defaultValue 'mouseenter'
+     * @gridInfoItem
+     * @noCodeItem
+     */
+    quickFilterValuesTrigger?: 'mouseenter' | 'click';
+    /**
+     * Sets a height for Quick Filter Bar (if not provided AG Grid's default is used)
+     *
+     * @defaultValue null
+     * @gridInfoItem
+     */
+    quickFilterHeight?: number;
+    /**
+     * When to re-filter grid after user edits data: 'Always', 'Never' or 'Throttle' (which requires a 'ThrottleDelay')
+     *
+     * @defaultValue 'Always'
+     */
+    filterActionOnUserDataChange?: FilterActionOnDataChange;
+    /**
+     * When to re-filter grid after data ticks: 'Always', 'Never' or 'Throttle' (which requires a 'ThrottleDelay')
+     *
+     * @defaultValue 'Never'
+     */
+    filterActionOnExternalDataChange?: FilterActionOnDataChange;
+    /**
+     * Apply selected filters (in Filter Form or Quick Filter Bar) as soon as they are clicked; if false an Apply Filter button is displayed
+     *
+     * @defaultValue true
+     * @gridInfoItem
+     * @noCodeItem
+     */
+    autoApplyFilter?: boolean;
+    /**
+     * Clears saved Column Filters when AdapTable loads
+     *
+     * @defaultValue false
+     * @gridInfoItem
+     */
+    clearFiltersOnStartUp?: boolean;
+    /**
+     * Whether column values in filter dropdown should apply column's current Sort Order for the column
+     *
+     * @defaultValue false
+     * @gridInfoItem
+     */
+    sortColumnValuesInFilter?: boolean;
+    /**
+     * Default filter type for numeric Columns
+     *
+     * @defaultValue Equals
+     * @gridInfoItem
+     */
+    defaultNumericColumnFilter?: StrictExtract<SystemFilterPredicateId, 'GreaterThan' | 'LessThan' | 'Equals' | 'NotEquals' | 'Values'> | ((column: AdaptableColumn) => StrictExtract<SystemFilterPredicateId, 'GreaterThan' | 'LessThan' | 'Equals' | 'NotEquals' | 'Values'>);
+    /**
+     * Default filter type for string Columns
+     *
+     * @defaultValue Contains
+     * @gridInfoItem
+     */
+    defaultStringColumnFilter?: StrictExtract<SystemFilterPredicateId, 'Is' | 'IsNot' | 'Contains' | 'NotContains' | 'StartsWith' | 'EndsWith' | 'Regex' | 'Values'> | ((column: AdaptableColumn) => StrictExtract<SystemFilterPredicateId, 'Is' | 'IsNot' | 'Contains' | 'NotContains' | 'StartsWith' | 'EndsWith' | 'Regex' | 'Values'>);
+    /**
+     * Default filter type for date Columns
+     *
+     * @defaultValue On
+     * @gridInfoItem
+     */
+    defaultDateColumnFilter?: StrictExtract<SystemFilterPredicateId, 'After' | 'Before' | 'On' | 'NotOn' | 'Values'> | ((column: AdaptableColumn) => StrictExtract<SystemFilterPredicateId, 'After' | 'Before' | 'On' | 'NotOn' | 'Values'>);
+    /**
+     * Whether to open the Filter Form on the Values or Predicates tab
+     *
+     * @defaultValue 'Values'
+     * @gridInfoItem
+     */
+    defaultFilterFormTab?: 'Values' | 'Predicates';
+    /**
+     * Allows filtering on Calculated & FreeText columns
+     *
+     * @defaultValue true
+     * @gridInfoItem
+     */
+    enableFilterOnSpecialColumns?: boolean;
+    /**
+     * Whether to display Quick Filter Bar between Column Header and the Grid (provided its been setup)
+     * @defaultValue  true
+     * @noCodeItem
+     */
+    showQuickFilter?: boolean;
+    /**
+     * If Values filter should filter on datetime rather than date
+     * @defaultValue  true
+     * @noCodeItem
+     */
+    filterUsingTime?: boolean;
+    /**
+     * Display only currently filtered distinct values in Filter controls
+     *
+     * @defaultValue false
+     * @gridInfoItem
+     * @noCodeItem
+     */
+    showDistinctFilteredValuesOnly?: boolean;
+    /**
+     * Display Clear Filter button in Toolbar and Tool Panel
+     * @defaultValue  false
+     * @gridInfoItem
+     * @noCodeItem
+     */
+    showClearFilterButton?: boolean;
+    /**
+     * Display Suspend / Unsuspend Button in Toolbar and Tool Panel
+     * @defaultValue  false
+     * @gridInfoItem
+     * @noCodeItem
+     */
+    showSuspendFilterButton?: boolean;
+    /**
+     * Shortcut Keys to activate a Quick Filter Predicate
+     */
+    quickFilterWildcards?: Partial<Record<SystemAlertPredicateId, string[]>>;
+    /**
+     * Time to wait (in ms) before Filter Bar reacts to new value
+     * @defaultValue 250
+     * @gridInfoItem
+     */
+    quickFilterDebounce?: number;
+    /**
+     * Show the count of each distinct item for given column in the Values (IN) Filter
+     * @defaultValue  false
+     * @gridInfoItem
+     * @noCodeItem
+     */
+    showValuesCount?: (column: AdaptableColumn<TData>) => boolean;
+    /**
+     * Width of Values popup in Filter Bar - can be set width or same size as Column
+     * @defaultValue '180'
+     */
+    quickFilterValuesWidth?: 'auto' | number;
+    /**
+     * Includes a [BLANKS] entry in Values filter
+     * @defaultValue  false
+     * @gridInfoItem
+     * @noCodeItem
+     */
+    includeBlankFilterValues?: boolean;
+}
+/**
+ * Context provided when Column Filtering
+ */
+export interface ColumnFilterContext<TData = any> extends BaseContext {
+    /**
+     * Column being filtered
+     */
+    column: AdaptableColumn<TData>;
+}

package/src/AdaptableOptions/ColumnFilterOptions.js ADDED Viewed

	@@ -0,0 +1 @@
1	+ export {};

package/src/AdaptableOptions/ColumnOptions.js CHANGED Viewed

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

package/src/AdaptableOptions/ContainerOptions.js CHANGED Viewed

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

package/src/AdaptableOptions/CustomSortOptions.js CHANGED Viewed

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

package/src/AdaptableOptions/DashboardOptions.js CHANGED Viewed

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

package/src/AdaptableOptions/DataChangeHistoryOptions.js CHANGED Viewed

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

package/src/AdaptableOptions/DataImportOptions.js CHANGED Viewed

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

package/src/AdaptableOptions/DataSetOptions.js CHANGED Viewed

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

package/src/AdaptableOptions/DateInputOptions.js CHANGED Viewed

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

package/src/AdaptableOptions/EditOptions.js CHANGED Viewed

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

package/src/AdaptableOptions/EntitlementOptions.js CHANGED Viewed

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

package/src/AdaptableOptions/ExportOptions.d.ts CHANGED Viewed

@@ -52,6 +52,11 @@ export interface ExportOptions {
      * @gridInfoItem
      */
     appendFileTimestamp?: boolean;
+    /**
+     * Provide a Bespoke File name for the Report
+     * @param reportFileNameContext context about report being run
+     */
+    reportFilename?(reportFileNameContext: ReportFileNameContext): string;
     /**
      * Whether a Column is included in System Reports and available in UI for selection
      * @defaultValue true
@@ -184,3 +189,16 @@ export interface ExportableColumnContext extends BaseContext {
      */
     adaptableColumn: AdaptableReportColumn;
 }
+/**
+ * Context used for providing a custom filename for a Report
+ */
+export interface ReportFileNameContext extends BaseContext {
+    /**
+     * Name of Report being run
+     */
+    reportName: string;
+    /**
+     * Report's destination
+     */
+    destination: SystemExportDestination | CustomDestination;
+}

package/src/AdaptableOptions/ExportOptions.js CHANGED Viewed

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

package/src/AdaptableOptions/ExpressionOptions.js CHANGED Viewed

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

package/src/AdaptableOptions/Fdc3Options.js CHANGED Viewed

@@ -1,5 +1,2 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.FieldRefTypePrefix = exports.ColumnRefTypePrefix = void 0;
-exports.ColumnRefTypePrefix = '_colId.';
-exports.FieldRefTypePrefix = '_field.';
+export const ColumnRefTypePrefix = '_colId.';
+export const FieldRefTypePrefix = '_field.';

package/src/AdaptableOptions/FilterOptions.d.ts CHANGED Viewed

@@ -1,9 +1,10 @@
 import { AdaptableColumn } from '../PredefinedConfig/Common/AdaptableColumn';
 import { FilterActionOnDataChange } from '../PredefinedConfig/Common/FilterActionOnDataChange';
-import { BaseContext, SystemAlertPredicateId, SystemFilterPredicateId } from '../../types';
+import { ColumnFilterContext, SystemAlertPredicateId, SystemFilterPredicateId } from '../../types';
 import { StrictExtract } from '../Utilities/Extensions/TypeExtensions';
 /**
  * Options for managing Filtering in AdapTable
+ * @deprecated use ColumnFilterOptions instead
  */
 export interface FilterOptions<TData = any> {
     /**
@@ -11,13 +12,13 @@ export interface FilterOptions<TData = any> {
      *
      * @defaultValue undefined
      */
-    hideQuickFilterDropdown?: (filterContext: FilterContext<TData>) => boolean;
+    hideQuickFilterDropdown?: (columFilterContext: ColumnFilterContext<TData>) => boolean;
     /**
      * Hides Input in Quick Filter Bar for a given Column
      *
      * @defaultValue undefined
      */
-    hideQuickFilterInput?: (filterContext: FilterContext<TData>) => boolean;
+    hideQuickFilterInput?: (columFilterContext: ColumnFilterContext<TData>) => boolean;
     /**
      * Distinct column items to display in Filter Form; useful with large datasource (though AdapTable offers virtualisation)
      *
@@ -157,7 +158,7 @@ export interface FilterOptions<TData = any> {
     showQuickFilter?: boolean;
     /**
      * If Values filter should filter on datetime rather than date
-     * @defaultValue  true
+     * @defaultValue false
      * @noCodeItem
      */
     filterUsingTime?: boolean;
@@ -213,12 +214,3 @@ export interface FilterOptions<TData = any> {
      */
     includeBlankFilterValues?: boolean;
 }
-/**
- * Context provided when Filtering
- */
-export interface FilterContext<TData = any> extends BaseContext {
-    /**
-     * Column being filtered
-     */
-    column: AdaptableColumn<TData>;
-}

package/src/AdaptableOptions/FilterOptions.js CHANGED Viewed

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

package/src/AdaptableOptions/FinancePluginOptions.js CHANGED Viewed

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

package/src/AdaptableOptions/FinsemblePluginOptions.js CHANGED Viewed

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

package/src/AdaptableOptions/FlashingCellOptions.js CHANGED Viewed

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

package/src/AdaptableOptions/FormatColumnOptions.js CHANGED Viewed

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

package/src/AdaptableOptions/Glue42PluginOptions.js CHANGED Viewed

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

package/src/AdaptableOptions/Glue42WebPluginOptions.js CHANGED Viewed

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

package/src/AdaptableOptions/GroupingOptions.js CHANGED Viewed

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

package/src/AdaptableOptions/IPushPullPluginOptions.js CHANGED Viewed

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

package/src/AdaptableOptions/LayoutOptions.js CHANGED Viewed

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

package/src/AdaptableOptions/MasterDetailPluginOptions.js CHANGED Viewed

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

package/src/AdaptableOptions/MenuOptions.d.ts CHANGED Viewed

@@ -138,8 +138,8 @@ export interface AdaptableSystemMenuItem extends AdaptableMenuItem {
  */
 export interface UserContextMenuItem {
     /**
-   * Type of Menu - always 'Adaptable'
-   */
+     * Type of Menu - always 'Adaptable'
+     */
     menuType: 'User';
     /**
      * Text to appear in the Menu Item

package/src/AdaptableOptions/MenuOptions.js CHANGED Viewed

@@ -1,77 +1,91 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.DEFAULT_ADAPTABLE_COLUMN_MENU_ORDER = exports.DEFAULT_ADAPTABLE_CONTEXT_MENU_ORDER = void 0;
-const tslib_1 = require("tslib");
-const ModuleConstants = tslib_1.__importStar(require("../Utilities/Constants/ModuleConstants"));
-exports.DEFAULT_ADAPTABLE_CONTEXT_MENU_ORDER = [
+import * as ModuleConstants from '../Utilities/Constants/ModuleConstants';
+export const DEFAULT_ADAPTABLE_CONTEXT_MENU_ORDER = [
     ModuleConstants.SettingsPanelModuleId,
+    ModuleConstants.DashboardModuleId,
+    ModuleConstants.ToolPanelModuleId,
+    ModuleConstants.StatusBarModuleId,
     ModuleConstants.LayoutModuleId,
-    ModuleConstants.FlashingCellModuleId,
     ModuleConstants.FormatColumnModuleId,
     ModuleConstants.StyledColumnModuleId,
+    ModuleConstants.FlashingCellModuleId,
     ModuleConstants.CustomSortModuleId,
     ModuleConstants.CellSummaryModuleId,
     ModuleConstants.Fdc3ModuleId,
-    ModuleConstants.PlusMinusModuleId,
-    ModuleConstants.DashboardModuleId,
-    ModuleConstants.SystemStatusModuleId,
     ModuleConstants.GridInfoModuleId,
     ModuleConstants.ColumnInfoModuleId,
-    ModuleConstants.DataImportModuleId,
     ModuleConstants.AlertModuleId,
     ModuleConstants.CalculatedColumnModuleId,
     ModuleConstants.ExportModuleId,
-    ModuleConstants.FilterModuleId,
+    ModuleConstants.ColumnFilterModuleId,
     ModuleConstants.SmartEditModuleId,
     ModuleConstants.BulkUpdateModuleId,
     ModuleConstants.TeamSharingModuleId,
     ModuleConstants.DataChangeHistoryModuleId,
     ModuleConstants.DataSetModuleId,
     ModuleConstants.FreeTextColumnModuleId,
-    ModuleConstants.QueryModuleId,
+    ModuleConstants.NamedQueryModuleId,
     ModuleConstants.QuickSearchModuleId,
-    ModuleConstants.ScheduleModuleId,
+    ModuleConstants.DataSetModuleId,
+    ModuleConstants.AlertModuleId,
+    ModuleConstants.SystemStatusModuleId,
+    ModuleConstants.CalculatedColumnModuleId,
+    ModuleConstants.FreeTextColumnModuleId,
+    ModuleConstants.ExportModuleId,
+    ModuleConstants.DataImportModuleId,
+    ModuleConstants.DataChangeHistoryModuleId,
+    ModuleConstants.SmartEditModuleId,
+    ModuleConstants.PlusMinusModuleId,
+    ModuleConstants.BulkUpdateModuleId,
     ModuleConstants.ShortcutModuleId,
+    ModuleConstants.TeamSharingModuleId,
+    ModuleConstants.ScheduleModuleId,
     ModuleConstants.StateManagementModuleId,
-    ModuleConstants.ToolPanelModuleId,
     ModuleConstants.ThemeModuleId,
-    ModuleConstants.StatusBarModuleId,
     ModuleConstants.ChartingModuleId,
     ModuleConstants.NotesModuleId,
 ];
-exports.DEFAULT_ADAPTABLE_COLUMN_MENU_ORDER = [
+export const DEFAULT_ADAPTABLE_COLUMN_MENU_ORDER = [
     ModuleConstants.SettingsPanelModuleId,
+    ModuleConstants.DashboardModuleId,
+    ModuleConstants.ToolPanelModuleId,
+    ModuleConstants.StatusBarModuleId,
     ModuleConstants.LayoutModuleId,
-    ModuleConstants.FlashingCellModuleId,
     ModuleConstants.FormatColumnModuleId,
     ModuleConstants.StyledColumnModuleId,
+    ModuleConstants.FlashingCellModuleId,
     ModuleConstants.CustomSortModuleId,
     ModuleConstants.CellSummaryModuleId,
     ModuleConstants.Fdc3ModuleId,
-    ModuleConstants.PlusMinusModuleId,
-    ModuleConstants.DashboardModuleId,
-    ModuleConstants.SystemStatusModuleId,
     ModuleConstants.GridInfoModuleId,
     ModuleConstants.ColumnInfoModuleId,
-    ModuleConstants.DataImportModuleId,
     ModuleConstants.AlertModuleId,
     ModuleConstants.CalculatedColumnModuleId,
     ModuleConstants.ExportModuleId,
-    ModuleConstants.FilterModuleId,
+    ModuleConstants.ColumnFilterModuleId,
     ModuleConstants.SmartEditModuleId,
     ModuleConstants.BulkUpdateModuleId,
     ModuleConstants.TeamSharingModuleId,
     ModuleConstants.DataChangeHistoryModuleId,
     ModuleConstants.DataSetModuleId,
     ModuleConstants.FreeTextColumnModuleId,
-    ModuleConstants.QueryModuleId,
+    ModuleConstants.NamedQueryModuleId,
     ModuleConstants.QuickSearchModuleId,
-    ModuleConstants.ScheduleModuleId,
+    ModuleConstants.DataSetModuleId,
+    ModuleConstants.AlertModuleId,
+    ModuleConstants.SystemStatusModuleId,
+    ModuleConstants.CalculatedColumnModuleId,
+    ModuleConstants.FreeTextColumnModuleId,
+    ModuleConstants.ExportModuleId,
+    ModuleConstants.DataImportModuleId,
+    ModuleConstants.DataChangeHistoryModuleId,
+    ModuleConstants.SmartEditModuleId,
+    ModuleConstants.PlusMinusModuleId,
+    ModuleConstants.BulkUpdateModuleId,
     ModuleConstants.ShortcutModuleId,
+    ModuleConstants.TeamSharingModuleId,
+    ModuleConstants.ScheduleModuleId,
     ModuleConstants.StateManagementModuleId,
-    ModuleConstants.ToolPanelModuleId,
     ModuleConstants.ThemeModuleId,
-    ModuleConstants.StatusBarModuleId,
     ModuleConstants.ChartingModuleId,
     ModuleConstants.NotesModuleId,
 ];

package/src/AdaptableOptions/NotesOptions.js CHANGED Viewed

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

package/src/AdaptableOptions/NotificationsOptions.js CHANGED Viewed

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

package/src/AdaptableOptions/OpenFinPluginOptions.js CHANGED Viewed

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

package/src/AdaptableOptions/PredicateOptions.d.ts CHANGED Viewed

@@ -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/AdaptableOptions/PredicateOptions.js CHANGED Viewed

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