@adaptabletools/adaptable 16.0.0-canary.2 → 16.0.0-canary.4

package/src/Api/QuickSearchApi.d.ts

@@ -34,4 +34,12 @@ export interface QuickSearchApi {
      * Opens Settings Panel with Quick Search section selected and visible
      */
     openQuickSearchSettingsPanel(): void;
+    /**
+     * Opens the floating Quick Search
+     */
+    showFloatingQuickSearch(): void;
+    /**
+     * Hides the floating Quick Search
+     */
+    hideFloatingQuickSearch(): void;
 }

package/src/Api/StyledColumnApi.d.ts

@@ -57,11 +57,6 @@ export interface StyledColumnApi {
      * @param styledColumn
      */
     unSuspendStyledColumn(styledColumn: StyledColumn): void;
-    /**
-     * Returns first Styled Column that contains checkbox style
-     * @param columnId column to check
-     */
-    getCheckBoxStyleStyledColumn(column: AdaptableColumn): StyledColumn | undefined;
     /**
      * Checks whether Column with given `columnId` has a PercentBar Style applied
      * @param columnId column ID
@@ -77,15 +72,6 @@ export interface StyledColumnApi {
      * @param columnId column ID
      */
     isSparklineStyleStyledColumn(column: AdaptableColumn): boolean;
-    /**
-     * Whether given column is a (boolean) checkbox column
-     * @param columnId column to check
-     */
-    isCheckBoxStyleStyledColumn(column: AdaptableColumn): boolean;
-    /**
-     * Publishes the CheckboxColumnClickedEvent - when the checkbox in an Checkbox Column is clicked
-     */
-    fireCheckboxColumnClickedEvent(columnId: string, rowData: any, primaryKeyValue: any, isChecked: boolean): void;
     /**
      * Returns a Styled Column for a given column
      * @param column Column to check

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

@@ -2,7 +2,7 @@ import { AdaptableObject } from './AdaptableObject';
 /**
  * Type of data stored in an Adaptable Column
  */
-export declare type AdaptableColumnDataType = 'String' | 'Number' | 'Boolean' | 'Date' | 'Object' | 'NumberArray' | 'TupleNumberArray' | 'ObjectNumberArray' | 'Unknown';
+export declare type AdaptableColumnDataType = 'String' | 'Number' | 'Boolean' | 'Date' | 'Object' | 'StringArray' | 'NumberArray' | 'TupleNumberArray' | 'ObjectNumberArray' | 'Unknown';
 /**
  * Base class for Adaptable Column containing most important properties
  */

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

@@ -3,17 +3,17 @@ import { TypeHint } from './Types';
 /**
  * Defines an icon to be used in AdapTable (e.g. in Dashboard Header, Buttons, Menu, etc.)
  */
-export declare type AdaptableIcon = AdaptableInternalIcon | AdaptableExternalIcon | AdaptableElementIcon;
+export declare type AdaptableIcon = AdaptableSystemIcon | AdaptableCustomIcon | AdaptableElementIcon;
 /**
- * Defines an icon from the internal AdapTable icon set
+ * Defines an icon from the System AdapTable icon set
  */
-export interface AdaptableInternalIcon extends AdaptableBaseIcon {
+export interface AdaptableSystemIcon extends AdaptableBaseIcon {
     /**
      * The name of the icon to use (referencing the AdapTable Icon Library)
      *
      * The icon can be a adaptable icon or a custom one defined in `interfaceOptions.customIcons`
      */
-    name: TypeHint<string, AdaptableInternalIconName>;
+    name: TypeHint<string, AdaptableSystemIconName>;
     /**
      * The size (in pixels) of the SVG icon (defaults to `17px`)
      *
@@ -23,7 +23,7 @@ export interface AdaptableInternalIcon extends AdaptableBaseIcon {
 /**
  * Defines an icon from an external source
  */
-export interface AdaptableExternalIcon extends AdaptableBaseIcon {
+export interface AdaptableCustomIcon extends AdaptableBaseIcon {
     /**
      * The URL of the icon to use
      */
@@ -52,6 +52,6 @@ export interface AdaptableBaseIcon {
     style?: React.CSSProperties;
 }
 /**
- * All AdapTable internal icon names
+ * All AdapTable System Icon names
  */
-export declare type AdaptableInternalIconName = 'add' | 'alert' | 'building' | 'laptop' | 'arrow-down' | 'arrow-left' | 'arrow-right' | 'arrow-up' | 'arrow-up-long' | 'arrow-down-long' | 'arrow-expand' | 'paperclip' | 'unfilled-circle' | 'boolean-list' | 'broadcast' | 'brush' | 'spanner' | 'edit-table' | 'chart-and-grid' | 'calendar' | 'call' | 'cells' | 'flag' | 'chart' | 'chat' | 'check' | 'check-circle' | 'checked' | 'clone' | 'close' | 'cloud-upload' | 'collapse' | 'column-add' | 'columns' | 'filter-list' | 'comment' | 'contains' | 'dashboard' | 'data-set' | 'date-range' | 'delete' | 'division' | 'dock' | 'drag' | 'edit' | 'ends-with' | 'equals' | 'equation' | 'error' | 'expand' | 'exponent' | 'export' | 'export-data' | 'fast-backward' | 'fast-forward' | 'filter' | 'lightning' | 'folder' | 'folder-open' | 'folder-shared' | 'color-palette' | 'horizontal-lines' | 'function' | 'greater-than' | 'greater-than-or-equal' | 'history' | 'home' | 'import-export' | 'info' | 'brain' | 'download' | 'grid' | 'less-than' | 'less-than-or-equal' | 'list' | 'logout' | 'menu' | 'minus' | 'multiplication' | 'newpage' | 'news' | 'filled-circle' | 'not-contains' | 'not-equal' | 'open-in-new' | 'pause' | 'percent' | 'percent-tag' | 'person' | 'pie-chart' | 'play' | 'plus' | 'add-circle' | 'search' | 'search-table' | 'quote' | 'refresh' | 'regex' | 'reminder' | 'save' | 'schedule' | 'settings' | 'link' | 'sort-asc' | 'sort-desc' | 'spark-line' | 'starts-with' | 'assignment' | 'statusbar' | 'stop' | 'traffic-lights' | 'tab-unselected' | 'theme' | 'clipboard' | 'target' | 'triangle-down' | 'triangle-up' | 'unchecked' | 'undo' | 'downloaded' | 'upload' | 'warning' | 'gradient' | 'badge' | 'italic' | 'bold' | 'align-left' | 'align-right' | 'align-center' | 'align-justify' | 'underline' | 'strikethrough' | 'overline' | 'case-upper' | 'case-lower' | 'case-sentence' | 'visibility-on' | 'visibility-off' | 'visibility-off-bold' | 'visibility-on-bold';
+export declare type AdaptableSystemIconName = 'add' | 'alert' | 'building' | 'laptop' | 'arrow-down' | 'arrow-left' | 'arrow-right' | 'arrow-up' | 'arrow-up-long' | 'arrow-down-long' | 'arrow-expand' | 'paperclip' | 'unfilled-circle' | 'boolean-list' | 'broadcast' | 'brush' | 'spanner' | 'edit-table' | 'chart-and-grid' | 'calendar' | 'call' | 'cells' | 'fdc3' | 'flag' | 'chart' | 'chat' | 'check' | 'check-circle' | 'checked' | 'clone' | 'close' | 'cloud-upload' | 'collapse' | 'column-add' | 'columns' | 'filter-list' | 'comment' | 'contains' | 'dashboard' | 'data-set' | 'date-range' | 'delete' | 'division' | 'dock' | 'drag' | 'edit' | 'ends-with' | 'equals' | 'equation' | 'error' | 'expand' | 'exponent' | 'export' | 'export-data' | 'fast-backward' | 'fast-forward' | 'filter' | 'lightning' | 'folder' | 'folder-open' | 'folder-shared' | 'color-palette' | 'horizontal-lines' | 'function' | 'greater-than' | 'greater-than-or-equal' | 'history' | 'home' | 'import-export' | 'info' | 'brain' | 'download' | 'grid' | 'less-than' | 'less-than-or-equal' | 'list' | 'logout' | 'menu' | 'minus' | 'multiplication' | 'newpage' | 'news' | 'filled-circle' | 'not-contains' | 'not-equal' | 'open-in-new' | 'pause' | 'percent' | 'percent-tag' | 'person' | 'pie-chart' | 'play' | 'plus' | 'add-circle' | 'search' | 'search-table' | 'quote' | 'refresh' | 'regex' | 'reminder' | 'save' | 'schedule' | 'settings' | 'link' | 'sort-asc' | 'sort-desc' | 'spark-line' | 'starts-with' | 'assignment' | 'statusbar' | 'stop' | 'traffic-lights' | 'tab-unselected' | 'theme' | 'clipboard' | 'target' | 'triangle-down' | 'triangle-up' | 'unchecked' | 'undo' | 'downloaded' | 'upload' | 'warning' | 'gradient' | 'badge' | 'italic' | 'bold' | 'align-left' | 'align-right' | 'align-center' | 'align-justify' | 'underline' | 'strikethrough' | 'overline' | 'case-upper' | 'case-lower' | 'case-sentence' | 'visibility-on' | 'visibility-off' | 'visibility-off-bold' | 'visibility-on-bold';

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

@@ -1,7 +1,8 @@
-import { AdaptableScope } from './AdaptableScope';
-import { AdaptableColumn, AdaptableColumnDataType } from './AdaptableColumn';
-import { AdaptableApi, AdaptableIcon, ColumnFilter } from '../../types';
 import { IRowNode } from '@ag-grid-community/core';
+import { AdaptableIcon, ColumnFilter } from '../../types';
+import { AdaptableColumn, AdaptableColumnDataType } from './AdaptableColumn';
+import { AdaptableScope } from './AdaptableScope';
+import { BaseContext } from './BaseContext';
 /**
  * Predicate object used by AdapTableQL - essentially a boolean function
  */
@@ -51,7 +52,7 @@ export interface AdaptablePredicateDef {
     /**
      * Actual boolean function invoked when evaluating the Predicate
      */
-    handler: (params: PredicateDefHandlerParams) => boolean;
+    handler: (params: PredicateDefHandlerContext) => boolean;
     /**
      * String representation of the Predicate
      */
@@ -66,10 +67,6 @@ export interface AdaptablePredicateDef {
      * Keyboard shortcuts to initiate predicate - used in Quick Filter bar
      */
     shortcuts?: string[];
-    /**
-     * Display this predicate only in Quick Filter Bar (and NOT in Filter Form)
-     */
-    onlyQuickFilter?: boolean;
 }
 /**
  * Defines an Input to a Predicate
@@ -82,7 +79,7 @@ export interface PredicateDefInput {
 /**
  * Object passed into an Adaptable Predicate Definition
  */
-export interface PredicateDefHandlerParams {
+export interface PredicateDefHandlerContext extends BaseContext {
     /**
      * Raw value in cell being evaluated
      */
@@ -99,18 +96,14 @@ export interface PredicateDefHandlerParams {
      * AG Grid Row node which contains the cell
      */
     node: IRowNode;
-    /**
-     * Any inputs required to perform evaluation
-     */
-    inputs: any[];
     /**
      * Adaptable Column which contains the cell
      */
     column: AdaptableColumn;
     /**
-     * The Adaptable Api
+     * Any (optional) inputs required to perform evaluation
      */
-    api: AdaptableApi;
+    inputs?: any[];
 }
 /**
  * Inputs required for a Predicate

package/src/PredefinedConfig/Common/AdaptablePredicate.js

@@ -2,21 +2,22 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SystemBadgeStylePredicateIds = exports.SystemFlashingCellPredicateIds = exports.SystemFormatColumnPredicateIds = exports.SystemAlertPredicateIds = exports.SystemFilterPredicateIds = exports.SystemPredicateDefs = void 0;
 const tslib_1 = require("tslib");
-const Helper_1 = tslib_1.__importDefault(require("../../Utilities/Helpers/Helper"));
-const isToday_1 = tslib_1.__importDefault(require("date-fns/isToday"));
-const isYesterday_1 = tslib_1.__importDefault(require("date-fns/isYesterday"));
-const isTomorrow_1 = tslib_1.__importDefault(require("date-fns/isTomorrow"));
-const isThisWeek_1 = tslib_1.__importDefault(require("date-fns/isThisWeek"));
-const isThisMonth_1 = tslib_1.__importDefault(require("date-fns/isThisMonth"));
-const isThisQuarter_1 = tslib_1.__importDefault(require("date-fns/isThisQuarter"));
-const isThisYear_1 = tslib_1.__importDefault(require("date-fns/isThisYear"));
-const isPast_1 = tslib_1.__importDefault(require("date-fns/isPast"));
-const isFuture_1 = tslib_1.__importDefault(require("date-fns/isFuture"));
 const isAfter_1 = tslib_1.__importDefault(require("date-fns/isAfter"));
 const isBefore_1 = tslib_1.__importDefault(require("date-fns/isBefore"));
+const isEqual_1 = tslib_1.__importDefault(require("date-fns/isEqual"));
+const isFuture_1 = tslib_1.__importDefault(require("date-fns/isFuture"));
+const isPast_1 = tslib_1.__importDefault(require("date-fns/isPast"));
 const isSameDay_1 = tslib_1.__importDefault(require("date-fns/isSameDay"));
+const isThisMonth_1 = tslib_1.__importDefault(require("date-fns/isThisMonth"));
+const isThisQuarter_1 = tslib_1.__importDefault(require("date-fns/isThisQuarter"));
+const isThisWeek_1 = tslib_1.__importDefault(require("date-fns/isThisWeek"));
+const isThisYear_1 = tslib_1.__importDefault(require("date-fns/isThisYear"));
+const isToday_1 = tslib_1.__importDefault(require("date-fns/isToday"));
+const isTomorrow_1 = tslib_1.__importDefault(require("date-fns/isTomorrow"));
+const isYesterday_1 = tslib_1.__importDefault(require("date-fns/isYesterday"));
 const StringExtensions_1 = tslib_1.__importDefault(require("../../Utilities/Extensions/StringExtensions"));
 const DateHelper_1 = require("../../Utilities/Helpers/DateHelper");
+const Helper_1 = tslib_1.__importDefault(require("../../Utilities/Helpers/Helper"));
 /**
  * Array of Predicate Defs which are shipped by AdapTable
  */
@@ -27,20 +28,31 @@ exports.SystemPredicateDefs = [
         icon: { text: 'IN' },
         columnScope: { DataTypes: ['String', 'Number', 'Date'] },
         moduleScope: ['filter', 'formatColumn', 'alert', 'badgeStyle'],
-        handler: ({ inputs, column, value }) => {
+        handler: ({ inputs, column, value, adaptableApi }) => {
             if (inputs.length === 0) {
                 return true;
             }
             if (column.dataType === 'Date') {
                 return inputs.some((input) => {
-                    return (0, isSameDay_1.default)(input, value);
+                    if (adaptableApi.optionsApi.getFilterOptions().filterUsingTime) {
+                        return (0, isEqual_1.default)(input, value);
+                    }
+                    else {
+                        return (0, isSameDay_1.default)(input, value);
+                    }
                 });
             }
             if (column.dataType === 'Number') {
                 return inputs.includes(value);
             }
             if (column.dataType === 'String') {
-                return inputs.includes(value);
+                return adaptableApi.internalApi.isTextComparisonCaseSensitive()
+                    ? inputs
+                        .map((i) => {
+                        return i === null || i === void 0 ? void 0 : i.toLocaleLowerCase();
+                    })
+                        .includes(value === null || value === void 0 ? void 0 : value.toLocaleLowerCase())
+                    : inputs.includes(value);
             }
             return true;
         },
@@ -53,21 +65,34 @@ exports.SystemPredicateDefs = [
         icon: { text: '!IN' },
         columnScope: { DataTypes: ['String', 'Number', 'Date'] },
         moduleScope: ['filter', 'formatColumn', 'alert', 'badgeStyle'],
-        handler: ({ inputs, column, value }) => {
+        handler: ({ inputs, column, value, adaptableApi }) => {
             // basically negation of IN
             if (inputs.length === 0) {
                 return true;
             }
             if (column.dataType === 'Date') {
-                return inputs.every((input) => {
-                    return !(0, isSameDay_1.default)(input, value);
-                });
+                if (adaptableApi.optionsApi.getFilterOptions().filterUsingTime) {
+                    return inputs.every((input) => {
+                        return !(0, isEqual_1.default)(input, value);
+                    });
+                }
+                else {
+                    return inputs.every((input) => {
+                        return !(0, isSameDay_1.default)(input, value);
+                    });
+                }
             }
             if (column.dataType === 'Number') {
                 return !inputs.includes(value);
             }
             if (column.dataType === 'String') {
-                return !inputs.includes(value);
+                return adaptableApi.internalApi.isTextComparisonCaseSensitive()
+                    ? !inputs
+                        .map((i) => {
+                        return i === null || i === void 0 ? void 0 : i.toLocaleLowerCase();
+                    })
+                        .includes(value === null || value === void 0 ? void 0 : value.toLocaleLowerCase())
+                    : !inputs.includes(value);
             }
             return true;
         },
@@ -226,11 +251,11 @@ exports.SystemPredicateDefs = [
         columnScope: { DataTypes: ['String'] },
         moduleScope: ['filter', 'alert', 'flashingcell', 'formatColumn', 'badgeStyle'],
         inputs: [{ type: 'text' }],
-        handler: ({ value, inputs, api }) => {
+        handler: ({ value, inputs, adaptableApi }) => {
             if (!value) {
                 return false;
             }
-            const ignoreCase = !api.internalApi.isTextComparisonCaseSensitive();
+            const ignoreCase = !adaptableApi.internalApi.isTextComparisonCaseSensitive();
             const v = ignoreCase ? String(value).toLocaleLowerCase() : String(value);
             const i = ignoreCase ? String(inputs[0]).toLocaleLowerCase() : String(inputs[0]);
             return v == i;
@@ -245,11 +270,11 @@ exports.SystemPredicateDefs = [
         columnScope: { DataTypes: ['String'] },
         moduleScope: ['filter', 'alert', 'flashingcell', 'formatColumn', 'badgeStyle'],
         inputs: [{ type: 'text' }],
-        handler: ({ value, inputs, api }) => {
+        handler: ({ value, inputs, adaptableApi }) => {
             if (!value) {
                 return true;
             }
-            const ignoreCase = !api.internalApi.isTextComparisonCaseSensitive();
+            const ignoreCase = !adaptableApi.internalApi.isTextComparisonCaseSensitive();
             const v = ignoreCase ? String(value).toLocaleLowerCase() : String(value);
             const i = ignoreCase ? String(inputs[0]).toLocaleLowerCase() : String(inputs[0]);
             return v != i;
@@ -264,11 +289,11 @@ exports.SystemPredicateDefs = [
         columnScope: { DataTypes: ['String'] },
         moduleScope: ['filter', 'alert', 'flashingcell', 'formatColumn', 'badgeStyle'],
         inputs: [{ type: 'text' }],
-        handler: ({ value, inputs, api }) => {
+        handler: ({ value, inputs, adaptableApi }) => {
             if (!value) {
                 return false;
             }
-            const ignoreCase = !api.internalApi.isTextComparisonCaseSensitive();
+            const ignoreCase = !adaptableApi.internalApi.isTextComparisonCaseSensitive();
             const v = ignoreCase ? String(value).toLocaleLowerCase() : String(value);
             const i = ignoreCase ? String(inputs[0]).toLocaleLowerCase() : String(inputs[0]);
             return v.indexOf(i) !== -1;
@@ -282,11 +307,11 @@ exports.SystemPredicateDefs = [
         columnScope: { DataTypes: ['String'] },
         moduleScope: ['filter', 'alert', 'flashingcell', 'formatColumn', 'badgeStyle'],
         inputs: [{ type: 'text' }],
-        handler: ({ value, inputs, api }) => {
+        handler: ({ value, inputs, adaptableApi }) => {
             if (!value) {
                 return true;
             }
-            const ignoreCase = !api.internalApi.isTextComparisonCaseSensitive();
+            const ignoreCase = !adaptableApi.internalApi.isTextComparisonCaseSensitive();
             const v = ignoreCase ? String(value).toLocaleLowerCase() : String(value);
             const i = ignoreCase ? String(inputs[0]).toLocaleLowerCase() : String(inputs[0]);
             return v.indexOf(i) === -1;
@@ -300,11 +325,11 @@ exports.SystemPredicateDefs = [
         columnScope: { DataTypes: ['String'] },
         moduleScope: ['filter', 'alert', 'flashingcell', 'formatColumn', 'badgeStyle'],
         inputs: [{ type: 'text' }],
-        handler: ({ value, inputs, api }) => {
+        handler: ({ value, inputs, adaptableApi }) => {
             if (!value) {
                 return false;
             }
-            const ignoreCase = !api.internalApi.isTextComparisonCaseSensitive();
+            const ignoreCase = !adaptableApi.internalApi.isTextComparisonCaseSensitive();
             const v = ignoreCase ? String(value).toLocaleLowerCase() : String(value);
             const i = ignoreCase ? String(inputs[0]).toLocaleLowerCase() : String(inputs[0]);
             return v.startsWith(i);
@@ -318,11 +343,11 @@ exports.SystemPredicateDefs = [
         columnScope: { DataTypes: ['String'] },
         moduleScope: ['filter', 'alert', 'flashingcell', 'formatColumn', 'badgeStyle'],
         inputs: [{ type: 'text' }],
-        handler: ({ value, inputs, api }) => {
+        handler: ({ value, inputs, adaptableApi }) => {
             if (!value) {
                 return false;
             }
-            const ignoreCase = !api.internalApi.isTextComparisonCaseSensitive();
+            const ignoreCase = !adaptableApi.internalApi.isTextComparisonCaseSensitive();
             const v = ignoreCase ? String(value).toLocaleLowerCase() : String(value);
             const i = ignoreCase ? String(inputs[0]).toLocaleLowerCase() : String(inputs[0]);
             return v.endsWith(i);
@@ -458,7 +483,7 @@ exports.SystemPredicateDefs = [
         icon: { name: 'calendar' },
         columnScope: { DataTypes: ['Date'] },
         moduleScope: ['filter', 'alert', 'flashingcell', 'formatColumn'],
-        handler: ({ value, api }) => (0, isSameDay_1.default)((0, DateHelper_1.parseDateValue)(value), api.calendarApi.getNextWorkingDay()),
+        handler: ({ value, adaptableApi }) => (0, isSameDay_1.default)((0, DateHelper_1.parseDateValue)(value), adaptableApi.calendarApi.getNextWorkingDay()),
     },
     {
         id: 'LastWorkDay',
@@ -466,7 +491,7 @@ exports.SystemPredicateDefs = [
         icon: { name: 'calendar' },
         columnScope: { DataTypes: ['Date'] },
         moduleScope: ['filter', 'alert', 'flashingcell', 'formatColumn'],
-        handler: ({ value, api }) => (0, isSameDay_1.default)((0, DateHelper_1.parseDateValue)(value), api.calendarApi.getPreviousWorkingDay()),
+        handler: ({ value, adaptableApi }) => (0, isSameDay_1.default)((0, DateHelper_1.parseDateValue)(value), adaptableApi.calendarApi.getPreviousWorkingDay()),
     },
     {
         id: 'WorkDay',
@@ -474,7 +499,7 @@ exports.SystemPredicateDefs = [
         icon: { name: 'calendar' },
         columnScope: { DataTypes: ['Date'] },
         moduleScope: ['filter', 'alert', 'flashingcell', 'formatColumn'],
-        handler: ({ value, api }) => api.calendarApi.isWorkingDay(value),
+        handler: ({ value, adaptableApi }) => adaptableApi.calendarApi.isWorkingDay(value),
     },
     {
         id: 'Holiday',
@@ -482,7 +507,7 @@ exports.SystemPredicateDefs = [
         icon: { name: 'calendar' },
         columnScope: { DataTypes: ['Date'] },
         moduleScope: ['filter', 'alert', 'flashingcell', 'formatColumn'],
-        handler: ({ value, api }) => api.calendarApi.isHoliday(value),
+        handler: ({ value, adaptableApi }) => adaptableApi.calendarApi.isHoliday(value),
     },
     {
         id: 'InRange',
@@ -517,7 +542,6 @@ exports.SystemPredicateDefs = [
         columnScope: { DataTypes: ['Boolean'] },
         moduleScope: ['filter'],
         inputs: [{ type: 'boolean' }],
-        onlyQuickFilter: true,
         // working with string aliases instead of booleans because the FilterAPI cannot handle falsy filter values (it ignores them)
         handler: ({ value, inputs }) => {
             if (inputs[0] == 'all') {
@@ -554,9 +578,9 @@ exports.SystemPredicateDefs = [
         label: 'Primary Key Duplicate',
         columnScope: { All: true },
         moduleScope: ['alert'],
-        handler: ({ value, column, api, node }) => {
+        handler: ({ value, column, adaptableApi, node }) => {
             return (column === null || column === void 0 ? void 0 : column.isPrimaryKey)
-                ? api.gridApi.internalApi
+                ? adaptableApi.gridApi.internalApi
                     .getDistinctRawValuesForColumn(column.columnId, node)
                     .includes(value)
                 : false;
@@ -567,9 +591,9 @@ exports.SystemPredicateDefs = [
         label: 'Existing Values Only',
         columnScope: { All: true },
         moduleScope: ['alert'],
-        handler: ({ value, api, column, node }) => {
+        handler: ({ value, adaptableApi, column, node }) => {
             const distinctValues = column
-                ? api.gridApi.internalApi.getDistinctRawValuesForColumn(column.columnId, node)
+                ? adaptableApi.gridApi.internalApi.getDistinctRawValuesForColumn(column.columnId, node)
                 : [];
             return !distinctValues.includes(value);
         },
@@ -579,9 +603,9 @@ exports.SystemPredicateDefs = [
         label: 'No Duplicate Values',
         columnScope: { All: true },
         moduleScope: ['alert'],
-        handler: ({ value, api, column, node }) => {
+        handler: ({ value, adaptableApi, column, node }) => {
             const distinctValues = column
-                ? api.gridApi.internalApi.getDistinctRawValuesForColumn(column.columnId, node)
+                ? adaptableApi.gridApi.internalApi.getDistinctRawValuesForColumn(column.columnId, node)
                 : [];
             return distinctValues.includes(value);
         },

package/src/PredefinedConfig/Common/{FDC3Context.d.ts → FDC3Context_DEPR.d.ts}

@@ -10,11 +10,11 @@ import { FDC3Intent } from '../../types';
 /**
  * General-purpose context type, as defined by FDC3
  */
-export interface FDC3Context {
+export interface FDC3Context_DEPR {
     /**
-     * Type of FDC3Context that uniquely identifies it, e.g. "instrument"; used to refer to the accepted context(s) when declaring intents
+     * Type of FDC3Context_DEPR that uniquely identifies it, e.g. "instrument"; used to refer to the accepted context(s) when declaring intents
      */
-    type: FDC3ContextType;
+    type: FDC3ContextTypeDepr;
     /**
      * Name of the context data (optional) - a text string that describes the data being sent
      */
@@ -33,7 +33,7 @@ export interface FDC3Context {
 /**
  * FDC3 Context to define a financial Instrument
  */
-export interface InstrumentContext extends FDC3Context {
+export interface InstrumentContextDepr extends FDC3Context_DEPR {
     /**
      * Context type is always `instrument`
      */
@@ -61,7 +61,7 @@ export interface InstrumentContext extends FDC3Context {
 /**
  * FDC3 Context to define an array of financial Instruments
  */
-export interface InstrumentListContext extends FDC3Context {
+export interface InstrumentListContextDepr extends FDC3Context_DEPR {
     /**
      * Context type is always `instrumentList`
      */
@@ -77,12 +77,12 @@ export interface InstrumentListContext extends FDC3Context {
     /**
      * The instrument data
      */
-    instruments?: InstrumentContext[];
+    instruments?: InstrumentContextDepr[];
 }
 /**
  * FDC3 Context to define a financial Position (requires an Instrument)
  */
-export interface PositionContext extends FDC3Context {
+export interface PositionContextDepr extends FDC3Context_DEPR {
     /**
      * Context type is always `position`
      */
@@ -90,7 +90,7 @@ export interface PositionContext extends FDC3Context {
     /**
      * The `InstrumentContext` of the relevant Instrument
      */
-    instrument: InstrumentContext;
+    instrument: InstrumentContextDepr;
     /**
      * Free text name of Position
      */
@@ -107,7 +107,7 @@ export interface PositionContext extends FDC3Context {
 /**
  * FDC3 Context to define a financial Portfolio (array of Positions)
  */
-export interface PortfolioContext extends FDC3Context {
+export interface PortfolioContextDepr extends FDC3Context_DEPR {
     /**
      * Context type is always `portfolio`
      */
@@ -123,12 +123,12 @@ export interface PortfolioContext extends FDC3Context {
     /**
      * The position data
      */
-    positions?: PositionContext[];
+    positions?: PositionContextDepr[];
 }
 /**
  * FDC3 Context to define a Contact
  */
-export interface ContactContext extends FDC3Context {
+export interface ContactContextDepr extends FDC3Context_DEPR {
     /**
      * Context type is always `contact`
      */
@@ -150,7 +150,7 @@ export interface ContactContext extends FDC3Context {
 /**
  * FDC3 Context to define a list of Contacts
  */
-export interface ContactListContext extends FDC3Context {
+export interface ContactListContextDepr extends FDC3Context_DEPR {
     /**
      * Context type is always `contactList`
      */
@@ -166,12 +166,12 @@ export interface ContactListContext extends FDC3Context {
     /**
      * The array of Contacts
      */
-    contacts?: ContactContext[];
+    contacts?: ContactContextDepr[];
 }
 /**
  * FDC3 Context to define an Organization
  */
-export interface OrganizationContext extends FDC3Context {
+export interface OrganizationContextDepr extends FDC3Context_DEPR {
     /**
      * Context type is always `organization`
      */
@@ -194,7 +194,7 @@ export interface OrganizationContext extends FDC3Context {
 /**
  * FDC3 Context to define a Country
  */
-export interface CountryContext extends FDC3Context {
+export interface CountryContextDepr extends FDC3Context_DEPR {
     /**
      * Context type is always `country`
      */
@@ -228,19 +228,19 @@ export interface AdaptableFDC3EventInfo extends BaseEventInfo {
     /**
      * Full FDC3 Context for the object related to the event
      */
-    context: FDC3Context;
+    context: FDC3Context_DEPR;
 }
 /**
  * Defines which FDC3 context is being used
  */
-export declare type FDC3ContextType = 'fdc3.instrument' | 'fdc3.instrumentList' | 'fdc3.position' | 'fdc3.portfolio' | 'fdc3.contact' | 'fdc3.contactList' | 'fdc3.organization' | 'fdc3.country';
+export declare type FDC3ContextTypeDepr = 'fdc3.instrument' | 'fdc3.instrumentList' | 'fdc3.position' | 'fdc3.portfolio' | 'fdc3.contact' | 'fdc3.contactList' | 'fdc3.organization' | 'fdc3.country';
 /**
  * Context used when providing Custom FDC3 content
  */
-export interface CustomFDC3Context extends FDC3Context {
+export interface CustomFDC3Context extends FDC3Context_DEPR {
     type: any;
 }
 /**
  * Data used in FDC3 Contexts
  */
-export declare type ContextData = Record<string, unknown>;
+export declare type ContextDataDepr = Record<string, unknown>;

package/src/PredefinedConfig/Common/FDC3Context_DEPR.js

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

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

@@ -0,0 +1,53 @@
+import { Chart, ChatInitSettings, Contact, ContactList, Context, Country, Currency, Email, Instrument, InstrumentList, Nothing, Organization, Portfolio, Position, TimeRange, Valuation, ContextTypes } from '@finos/fdc3';
+export declare type Fdc3ContextType = ChartContextType | ChatInitSettingsContextType | ContactContextType | ContactListContextType | CountryContextType | CurrencyContextType | EmailContextType | InstrumentContextType | InstrumentListContextType | OrganizationContextType | PortfolioContextType | PositionContextType | TimeRangeContextType | ValuationContextType | NothingContextType;
+export declare const ChartContextKey = "fdc3.chart";
+export declare type ChartContextType = typeof ChartContextKey;
+export declare const ChatInitSettingsContextKey = "fdc3.chat.initSettings";
+export declare type ChatInitSettingsContextType = typeof ChatInitSettingsContextKey;
+export declare const ContactContextKey = "fdc3.contact";
+export declare type ContactContextType = typeof ContactContextKey;
+export declare const ContactListContextKey = "fdc3.contactList";
+export declare type ContactListContextType = typeof ContactListContextKey;
+export declare const CountryContextKey = "fdc3.country";
+export declare type CountryContextType = typeof CountryContextKey;
+export declare const CurrencyContextKey = "fdc3.currency";
+export declare type CurrencyContextType = typeof CurrencyContextKey;
+export declare const EmailContextKey = "fdc3.email";
+export declare type EmailContextType = typeof EmailContextKey;
+export declare const InstrumentContextKey = "fdc3.instrument";
+export declare type InstrumentContextType = typeof InstrumentContextKey;
+export declare const InstrumentListContextKey = "fdc3.instrumentList";
+export declare type InstrumentListContextType = typeof InstrumentListContextKey;
+export declare const OrganizationContextKey = "fdc3.organization";
+export declare type OrganizationContextType = typeof OrganizationContextKey;
+export declare const PortfolioContextKey = "fdc3.portfolio";
+export declare type PortfolioContextType = typeof PortfolioContextKey;
+export declare const PositionContextKey = "fdc3.position";
+export declare type PositionContextType = typeof PositionContextKey;
+export declare const TimeRangeContextKey = "fdc3.timerange";
+export declare type TimeRangeContextType = typeof TimeRangeContextKey;
+export declare const ValuationContextKey = "fdc3.valuation";
+export declare type ValuationContextType = typeof ValuationContextKey;
+export declare const NothingContextKey = "fdc3.nothing";
+export declare type NothingContextType = typeof NothingContextKey;
+export declare type Fdc3Context = ChartContext | ChatInitSettingsContext | ContactContext | ContactListContext | CountryContext | CurrencyContext | EmailContext | InstrumentContext | InstrumentListContext | OrganizationContext | PortfolioContext | PositionContext | TimeRangeContext | ValuationContext | NothingContext;
+export declare type Fdc3CustomContext = Context;
+export declare type TypedFdc3Context<CONTEXT, TYPE extends Fdc3ContextType> = CONTEXT & {
+    type: TYPE;
+};
+export declare type ChartContext = TypedFdc3Context<Chart, ContextTypes.Chart>;
+export declare type ChatInitSettingsContext = TypedFdc3Context<ChatInitSettings, ContextTypes.ChatInitSettings>;
+export declare type ContactContext = TypedFdc3Context<Contact, ContextTypes.Contact>;
+export declare type ContactListContext = TypedFdc3Context<ContactList, ContextTypes.ContactList>;
+export declare type CountryContext = TypedFdc3Context<Country, ContextTypes.Country>;
+export declare type CurrencyContext = TypedFdc3Context<Currency, ContextTypes.Currency>;
+export declare type EmailContext = TypedFdc3Context<Email, ContextTypes.Email>;
+export declare type InstrumentContext = TypedFdc3Context<Instrument, ContextTypes.Instrument>;
+export declare type InstrumentListContext = TypedFdc3Context<InstrumentList, ContextTypes.InstrumentList>;
+export declare type OrganizationContext = TypedFdc3Context<Organization, ContextTypes.Organization>;
+export declare type PortfolioContext = TypedFdc3Context<Portfolio, ContextTypes.Portfolio>;
+export declare type PositionContext = TypedFdc3Context<Position, ContextTypes.Position>;
+export declare type TimeRangeContext = TypedFdc3Context<TimeRange, ContextTypes.TimeRange>;
+export declare type ValuationContext = TypedFdc3Context<Valuation, ContextTypes.Valuation>;
+export declare type NothingContext = TypedFdc3Context<Nothing, ContextTypes.Nothing>;
+export declare const ContextLabels: Record<Fdc3ContextType, string>;