@adaptabletools/adaptable-cjs 19.2.4 → 20.0.0-canary.0

package/src/Strategy/TeamSharingModule.js

@@ -78,19 +78,19 @@ class TeamSharingModule extends AdaptableModuleBase_1.AdaptableModuleBase {
         if (!action) {
             return;
         }
-        return Object.values(action).find((actionProperty) => AdaptableHelper_1.default.isAdaptableObject(actionProperty));
+        return Object.values(action).find((actionPropertyValue) => AdaptableHelper_1.default.isAdaptableObject(actionPropertyValue));
     }
     isAdaptableObjectPresentInLocalState(sharedEntity) {
-        var _a;
-        return !!((_a = this.api.internalApi
+        return !!this.api.internalApi
             .getModuleService()
-            .getModuleById(sharedEntity.Module)) === null || _a === void 0 ? void 0 : _a.getModuleAdaptableObjects().find((adaptableObject) => adaptableObject.Uuid === sharedEntity.Entity.Uuid));
+            .getModuleById(sharedEntity.Module)
+            ?.getModuleAdaptableObjects()
+            .find((adaptableObject) => adaptableObject.Uuid === sharedEntity.Entity.Uuid);
     }
     isSharedEntityADependency(sharedEntity) {
         const allSharedEntries = this.api.teamSharingApi.getLoadedAdaptableSharedEntities();
         return allSharedEntries.some((sharedEntryCandidate) => {
-            var _a;
-            return (_a = sharedEntryCandidate === null || sharedEntryCandidate === void 0 ? void 0 : sharedEntryCandidate.EntityDependencyIds) === null || _a === void 0 ? void 0 : _a.includes(sharedEntity.Uuid);
+            return sharedEntryCandidate?.EntityDependencyIds?.includes(sharedEntity.Uuid);
         });
     }
     isStaleAndActive(sharedEntity) {
@@ -116,7 +116,7 @@ class TeamSharingModule extends AdaptableModuleBase_1.AdaptableModuleBase {
         const isDependency = this.isSharedEntityADependency(sharedEntity);
         const staleDependencies = this.getStaleDependencies(sharedEntity);
         const staleDependenciesViewItems = [];
-        if (staleDependencies === null || staleDependencies === void 0 ? void 0 : staleDependencies.length) {
+        if (staleDependencies?.length) {
             staleDependenciesViewItems.push({
                 name: 'Stale Deps',
                 view: (0, SharedEntityObjectView_1.getSharedEntityStaleDepsItemView)(staleDependencies),
@@ -149,6 +149,7 @@ class TeamSharingModule extends AdaptableModuleBase_1.AdaptableModuleBase {
                 ...staleDependenciesViewItems,
                 ArrayExtensions_1.default.IsNotNullOrEmpty(sharedEntity.EntityDependencyIds) && {
                     name: 'Dependencies',
+                    isLabelInline: true,
                     view: SharedEntityDependencies_1.SharedEntityDependencies,
                 },
             ].filter(Boolean),
@@ -156,8 +157,7 @@ class TeamSharingModule extends AdaptableModuleBase_1.AdaptableModuleBase {
         };
     }
     toViewAll() {
-        var _a;
-        return (((_a = this.api.teamSharingApi.getLoadedAdaptableSharedEntities()) !== null && _a !== void 0 ? _a : [])
+        return ((this.api.teamSharingApi.getLoadedAdaptableSharedEntities() ?? [])
             // only top level
             .filter((sharedEntity) => !this.isSharedEntityADependency(sharedEntity))
             .map((item) => this.toView(item)));

package/src/Strategy/Utilities/Alert/getAlertPreviewViewItems.js

@@ -9,8 +9,7 @@ const getAlertPreviewViewItems = (alert, api) => {
     return {
         name: 'Type and Display',
         view: () => {
-            var _a;
-            if (!((_a = alert === null || alert === void 0 ? void 0 : alert.AlertProperties) === null || _a === void 0 ? void 0 : _a.DisplayNotification)) {
+            if (!alert?.AlertProperties?.DisplayNotification) {
                 return React.createElement(Tag_1.Tag, null, alert.MessageType);
             }
             return (React.createElement(AlertNotificationWizardSection_1.AlertPreview, { focusFirstButton: false, style: { maxWidth: 400 }, mt: 2, api: api, alertDefinition: alert }));

package/src/Strategy/Utilities/CustomSort/getCustomSortSortOrderViewItems.d.ts

@@ -1,5 +1,5 @@
 import { CustomSort } from '../../../../types';
 export declare const getCustomSortSortOrderViewItems: (customSort: CustomSort) => {
     name: string;
-    values: any[];
+    values: (string | number)[];
 };

package/src/Strategy/Utilities/Export/getExportRowsViewItems.d.ts

@@ -1,6 +1,6 @@
-/// <reference types="react" />
+import * as React from 'react';
 import { AdaptableApi, Report } from '../../../types';
 export declare const getExportRowsViewItems: (report: Report, api: AdaptableApi) => {
     name: string;
-    view: JSX.Element;
+    view: React.JSX.Element;
 };

package/src/Strategy/Utilities/FormatColumn/getFormatColumnSettingsViewItems.js

@@ -2,12 +2,11 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getFormatColumnSettingsViewItems = void 0;
 const getFormatColumnSettingsViewItems = (formatColumn) => {
-    var _a, _b, _c, _d;
     const values = [
-        `Cell alignment: ${(_a = formatColumn.CellAlignment) !== null && _a !== void 0 ? _a : 'default'}`,
-        `Data Rows: ${((_b = formatColumn.RowScope) === null || _b === void 0 ? void 0 : _b.ExcludeDataRows) ? 'Yes' : 'No'}`,
-        `Group Rows: ${((_c = formatColumn.RowScope) === null || _c === void 0 ? void 0 : _c.ExcludeGroupRows) ? 'Yes' : 'No'}`,
-        `Row Summaries: ${((_d = formatColumn.RowScope) === null || _d === void 0 ? void 0 : _d.ExcludeSummaryRows) ? 'Yes' : 'No'}`,
+        `Cell alignment: ${formatColumn.CellAlignment ?? 'default'}`,
+        `Data Rows: ${formatColumn.RowScope?.ExcludeDataRows ? 'Yes' : 'No'}`,
+        `Group Rows: ${formatColumn.RowScope?.ExcludeGroupRows ? 'Yes' : 'No'}`,
+        `Row Summaries: ${formatColumn.RowScope?.ExcludeSummaryRows ? 'Yes' : 'No'}`,
     ].filter(Boolean);
     return {
         name: 'Settings',

package/src/Strategy/Utilities/FormatColumn/getFormatColumnStyleViewItems.d.ts

@@ -1,3 +1,3 @@
-/// <reference types="react" />
+import * as React from 'react';
 import { AdaptableApi, FormatColumn } from '../../../types';
-export declare const getFormatColumnStyleViewItems: (formatColumn: FormatColumn, api: AdaptableApi) => JSX.Element;
+export declare const getFormatColumnStyleViewItems: (formatColumn: FormatColumn, api: AdaptableApi) => React.JSX.Element;

package/src/Strategy/Utilities/Layout/getLayoutFilterViewItems.js

@@ -1,30 +1,23 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getLayoutFilterViewItems = exports.getFilterPreview = void 0;
+const utils_1 = require("../../..//View/Components/ColumnFilter/utils");
+const adaptableQlUtils_1 = require("../../../Utilities/adaptableQlUtils");
 const getFilterPreview = (columnFilter, api) => {
-    var _a, _b, _c;
-    const columnIdToFriendlyName = (columnId) => {
-        return api.columnApi.getFriendlyNameForColumnId(columnId);
-    };
-    return `[${columnIdToFriendlyName(columnFilter.ColumnId)}: ${(_a = columnFilter === null || columnFilter === void 0 ? void 0 : columnFilter.Predicate) === null || _a === void 0 ? void 0 : _a.PredicateId}${((_c = (_b = columnFilter.Predicate) === null || _b === void 0 ? void 0 : _b.Inputs) !== null && _c !== void 0 ? _c : [])
-        .map((input) => {
-        if (typeof input === 'string') {
-            return input;
-        }
-        if (typeof (input === null || input === void 0 ? void 0 : input.toString) === 'function') {
-            return input.toString();
-        }
-        return '';
-    })
-        .filter(Boolean)
-        .join(', ')}]`;
+    const column = api.columnApi.getColumnWithColumnId(columnFilter.ColumnId);
+    const columnFilterOptions = api.optionsApi.getFilterOptions().columnFilterOptions;
+    const predicateDefs = api.filterApi.columnFilterApi.getFilterPredicateDefsForColumn(column);
+    const columnType = api.columnApi.getColumnDataTypeForColumnId(columnFilter.ColumnId);
+    const qlDataType = (0, adaptableQlUtils_1.mapColumnDataTypeToExpressionFunctionType)(columnType);
+    const qlPredicateDefs = predicateDefs.map((pd) => (0, utils_1.mapAdaptablePredicateDefToQlPredicateDef)(pd, qlDataType));
+    const qlPredicate = (0, utils_1.mapColumnFilterToQlPredicate)(columnFilter, column, qlPredicateDefs, columnFilterOptions);
+    return `[${(0, utils_1.qlPredicateToString)(qlPredicate, qlPredicateDefs)}]`;
 };
 exports.getFilterPreview = getFilterPreview;
 const getLayoutFilterViewItems = (layout, api) => {
-    var _a;
     return {
         name: 'Column Filters',
-        values: ((_a = layout.ColumnFilters) !== null && _a !== void 0 ? _a : []).map((columnFilter) => (0, exports.getFilterPreview)(columnFilter, api)),
+        values: (layout.ColumnFilters ?? []).map((columnFilter) => (0, exports.getFilterPreview)(columnFilter, api)),
     };
 };
 exports.getLayoutFilterViewItems = getLayoutFilterViewItems;

package/src/Strategy/Utilities/Layout/getLayoutSortViewItems.js

@@ -2,13 +2,12 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getLayoutSortViewItems = void 0;
 const getLayoutSortViewItems = (layout, api) => {
-    var _a;
     const columnIdToFriendlyName = (columnId) => {
         return api.columnApi.getFriendlyNameForColumnId(columnId);
     };
     return {
         name: 'Sort',
-        values: ((_a = layout.ColumnSorts) !== null && _a !== void 0 ? _a : []).map((customSort) => `[${columnIdToFriendlyName(customSort.ColumnId)}: ${customSort.SortOrder}]`),
+        values: (layout.ColumnSorts ?? []).map((customSort) => `[${columnIdToFriendlyName(customSort.ColumnId)}: ${customSort.SortOrder}]`),
     };
 };
 exports.getLayoutSortViewItems = getLayoutSortViewItems;

package/src/Strategy/Utilities/Shortcut/getShortcutSettingsViewItems.js

@@ -2,11 +2,10 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getShortcutSettingsViewItems = void 0;
 const getShortcutSettingsViewItems = (shortcut) => {
-    var _a, _b;
     const values = [
         `Shortcut Key: ${shortcut.ShortcutKey || 'Not selected'}`,
-        `Value: ${(_a = shortcut.ShortcutValue) !== null && _a !== void 0 ? _a : 'Not specified'}`,
-        `Operation: ${(_b = shortcut.ShortcutOperation) !== null && _b !== void 0 ? _b : 'Not Specified'}`,
+        `Value: ${shortcut.ShortcutValue ?? 'Not specified'}`,
+        `Operation: ${shortcut.ShortcutOperation ?? 'Not Specified'}`,
     ];
     return {
         name: 'Settings',

package/src/Utilities/Constants/DocumentationLinkConstants.d.ts

@@ -1,16 +1,16 @@
 export declare const HOST_URL_DOCS = "https://docs.adaptabletools.com";
-export declare const ExpressionEditorDocsLink: string;
-export declare const BooleanQueryDocsLink: string;
-export declare const ScalarQueryDocsLink: string;
-export declare const ObservableQueryDocsLink: string;
-export declare const AggregatedBooleanQueryDocsLink: string;
-export declare const AggregatedScalarQueryDocsLink: string;
-export declare const CumulativeAggregatedScalarQueryDocsLink: string;
-export declare const QuantileAggregatedScalarQueryDocsLink: string;
-export declare const PredicateDocsLink: string;
-export declare const PrimaryKeyDocsLink: string;
-export declare const LicenseDocsLink: string;
-export declare const AdaptableOptionsDocsLink: string;
-export declare const AgGridModulesDocsLink: string;
-export declare const AlertMessageDocsLink: string;
-export declare const FormatColumnPlaceholderDocsLink: string;
+export declare const ExpressionEditorDocsLink = "https://docs.adaptabletools.com/guide/ui-expression-editor";
+export declare const BooleanQueryDocsLink = "https://docs.adaptabletools.com/guide/adaptable-ql-expression-standard";
+export declare const ScalarQueryDocsLink = "https://docs.adaptabletools.com/guide/adaptable-ql-expression-standard";
+export declare const ObservableQueryDocsLink = "https://docs.adaptabletools.com/guide/adaptable-ql-expression-observable";
+export declare const AggregatedBooleanQueryDocsLink = "https://docs.adaptabletools.com/guide/adaptable-ql-expression-aggregation";
+export declare const AggregatedScalarQueryDocsLink = "https://docs.adaptabletools.com/guide/adaptable-ql-expression-aggregation";
+export declare const CumulativeAggregatedScalarQueryDocsLink = "https://docs.adaptabletools.com/guide/adaptable-ql-expression-cumulative";
+export declare const QuantileAggregatedScalarQueryDocsLink = "https://docs.adaptabletools.com/guide/adaptable-ql-expression-quantile";
+export declare const PredicateDocsLink = "https://docs.adaptabletools.com/guide/adaptable-predicate";
+export declare const PrimaryKeyDocsLink = "https://docs.adaptabletools.com/guide/getting-started-primary-key";
+export declare const LicenseDocsLink = "https://docs.adaptabletools.com/guide/licensing";
+export declare const AdaptableOptionsDocsLink = "https://docs.adaptabletools.com/guide/reference-options-overview";
+export declare const AgGridModulesDocsLink = "https://docs.adaptabletools.com/guide/dev-guide-aggrid-modules-overview";
+export declare const AlertMessageDocsLink = "https://docs.adaptabletools.com/guide/handbook-alerting-message";
+export declare const FormatColumnPlaceholderDocsLink = "https://docs.adaptabletools.com/guide/handbook-column-formatting-display-format-placeholder";

package/src/Utilities/Constants/GeneralConstants.d.ts

@@ -1,116 +1,62 @@
-import { SummaryOperation } from '../../PredefinedConfig/Common/Enums';
-import { AdaptableTheme } from '../../PredefinedConfig/ThemeState';
 import { AdaptableMessageType } from '../../PredefinedConfig/Common/AdaptableMessageType';
-import { AdaptableColumnType, AdaptableModule } from '../../PredefinedConfig/Common/Types';
-import { AccessLevel } from '../../PredefinedConfig/Common/Entitlement';
-import { DataChangeDetectionPolicy } from '../../AdaptableOptions/AlertOptions';
-import { ToastPositions, ToastTransitions } from '../../AdaptableOptions/NotificationsOptions';
-import { FlashTarget } from '../../AdaptableOptions/FlashingCellOptions';
-import { DashboardButtonsLocation } from '../../AdaptableOptions/DashboardOptions';
-import { PopupType } from '../../AdaptableOptions/SettingsPanelOptions';
-import { SaveChartBehaviour } from '../../AdaptableOptions/ChartingOptions';
-import { DisplayRowGroups } from '../../AdaptableOptions/LayoutOptions';
+import { AdaptableModule } from '../../PredefinedConfig/Common/Types';
+import { SystemReportFormat, SystemReportName } from '../../PredefinedConfig/ExportState';
+import { SystemExportDestination } from '../../AdaptableOptions/ExportOptions';
+import { TableLayout } from '../../PredefinedConfig/LayoutState';
 export declare const AUTOGENERATED_PK_COLUMN: string;
 export declare const MISSING_COLUMN: string;
-export declare const DEFAULT_LAYOUT: string;
 export declare const LIGHT_THEME: string;
 export declare const DARK_THEME: string;
 export declare const OS_THEME: string;
-export declare const USER_NAME: string;
-export declare const ADAPTABLE_ID: string;
+export declare const ERROR_LAYOUT: TableLayout;
 export declare const ADAPTABLE: string;
-export declare const ADAPTABLE_CONTAINER_ID: string;
-export declare const AG_GRID_CONTAINER_ID: string;
+export declare const ADAPTABLE_ID: string;
 export declare const ADAPTABLE_TOOLPANEL_ID: string;
 export declare const ADAPTABLE_TOOLPANEL_COMPONENT: string;
 export declare const AGGRID_TOOLPANEL_FILTERS: string;
 export declare const AGGRID_TOOLPANEL_COLUMNS: string;
-export declare const MENU_PREFIX: string;
 export declare const READ_ONLY_STYLE: string;
-export declare const ALL_COLUMN_VALUES: string;
 export declare const EMPTY_STRING: string;
 export declare const EMPTY_ARRAY: any[];
-export declare const AB_SPECIAL_COLUMN: AdaptableColumnType;
-export declare const AB_ROW_ACTIONS_COLUMN: AdaptableColumnType;
-export declare const AB_FDC3_COLUMN: AdaptableColumnType;
 export declare const HALF_SECOND: number;
+export declare const QUARTER_SECOND: number;
 export declare const GROUP_PATH_SEPARATOR: string;
 export declare const AG_GRID_GROUPED_COLUMN: string;
 export declare const AG_GRID_PIVOT_COLUMN: string;
 export declare const AG_GRID_CHART_WINDOW = "AG Grid Window";
-export declare const ADAPTABLE_ROW_ACTION_BUTTONS = "adaptableRowActionButtons";
-export declare const ADAPTABLE_ROW_ACTION_BUTTONS_FRIENDLY_NAME = "(ActionRowButtons)";
 export declare const ADAPTABLE_FDC3_ACTION_COLUMN_FRIENDLY_NAME = "(FDC3ActionColumn)";
 export declare const DEFAULT_DATE_FORMAT_PATTERN = "dd-MM-yyyy";
 export declare const DEFAULT_DATE_FORMAT_PATTERN_WITH_TIME = "dd-MM-yyyy HH:mm:ss";
-export declare const BLANK_DISTINCT_COLUMN_VALUE = "[BLANKS]";
 export declare const DEFAULT_STRING_DISPLAY_VALUE = "Hello World";
 export declare const DEFAULT_INTEGER_DISPLAY_VALUE = 12345;
 export declare const DEFAULT_DOUBLE_DISPLAY_VALUE = 12345.6789;
-export declare const RAW_VALUE_DATA_CHANGE_DETECTION_POLICY: DataChangeDetectionPolicy;
-export declare const TOAST_POSITIONS_BOTTOM_RIGHT: ToastPositions;
-export declare const TOAST_TRANSITIONS_SLIDE: ToastTransitions;
-export declare const NOTIFICATION_DURATION = 3000;
-export declare const NOTIFICATION_MAX_SYSTEM_MESSAGES = 100;
-export declare const QUICK_SEARCH_PLACEHOLDER = "Search";
-export declare const DASHBOARD_BUTTONS_LOCATION_LEFT: DashboardButtonsLocation;
-export declare const DASHBOARD_BUTTONS_LOCATION_RIGHT: DashboardButtonsLocation;
-export declare const ENGLISH_VARIANT = "GB";
-export declare const LOADING_SCREEN_DELAY = 200;
-export declare const LOADING_SCREEN_TITLE = "Initialising Grid";
-export declare const LOADING_SCREEN_TEXT = "Retrieving your settings and setting up the grid...";
-export declare const DATE_INPUT_DATE_FORMAT = "yyyy-MM-dd";
-export declare const FLASHING_TARGET_CELL: FlashTarget;
-export declare const FLASHING_TARGET_ROW: FlashTarget;
-export declare const ICON_CONFIGURATION = "ConfigurationIcon";
-export declare const POPUP_TYPE_MODAL: PopupType;
-export declare const POPUP_TYPE_WINDOW: PopupType;
-export declare const SAVE_CHART_BEHAVIOUR_AUTO: SaveChartBehaviour;
-export declare const SAVE_CHART_BEHAVIOUR_MANUAL: SaveChartBehaviour;
-export declare const SAVE_CHART_BEHAVIOUR_NONE: SaveChartBehaviour;
-export declare const DISPLAY_ROW_GROUPS_DYNAMIC: DisplayRowGroups;
-export declare const DISPLAY_ROW_GROUPS_EXPANDED: DisplayRowGroups;
-export declare const DISPLAY_ROW_GROUPS_CLOSED: DisplayRowGroups;
-export declare const FDC3_ACTION_COLUMN_DEFAULT_COLUMN_ID = "fdc3ActionColumn";
-export declare const FDC3_ACTION_COLUMN_DEFAULT_HEADER_NAME = "FDC3 Actions";
-export declare const ACCESS_LEVEL_READONLY: AccessLevel;
-export declare const ACCESS_LEVEL_HIDDEN: AccessLevel;
-export declare const ACCESS_LEVEL_FULL: AccessLevel;
-export declare const STANDALONE_MODULE_POPUPS: AdaptableModule[];
-export declare const SYSTEM_STATUS_DEFAULT_MAX_MESSAGES_IN_STORE: number;
-export declare const QUICK_SEARCH_DEFAULT_BACK_COLOR: string;
-export declare const QUICK_SEARCH_DEFAULT_FORE_COLOR: string;
 export declare const QUICK_SEARCH_DEBOUNCE_TIME: number;
-export declare const CELL_SUMMARY_DEFAULT_OPERATION: SummaryOperation | string;
-export declare const SYSTEM_DEFAULT_SYSTEM_STATUS_TYPE: AdaptableMessageType;
-export declare const THEME_DEFAULT_CURRENT_THEME: string;
+export declare const MENU_SEPARATOR: string;
 export declare const DEFAULT_LIVE_REPORT_THROTTLE_TIME: number;
 export declare const SERVER_VALIDATION_HEADER: string;
 export declare const SERVER_VALIDATION_MESSAGE_TYPE: AdaptableMessageType;
-/**
- * Object Factory
- */
-export declare const PLUS_MINUS_DEFAULT_NUDGE_VALUE: number;
-export declare const ALERT_DEFAULT_MESSAGE_TYPE: AdaptableMessageType;
-export declare const ALERT_DEFAULT_SHOW_POPUP: boolean;
-/**
- * Constants for State (primarily for audit property events) - good idea?
- */
-export declare const SUMMARY_OPERATION_STATE_PROPERTY: string;
-export declare const CURRENT_LAYOUT_STATE_PROPERTY: string;
-export declare const CURRENT_REPORT_STATE_PROPERTY: string;
-export declare const FLASHING_CELL_DEFAULT_UP_COLOR_STATE_PROPERTY: string;
-export declare const FLASHING_CELL_DEFAULT_DOWN_COLOR_STATE_PROPERTY: string;
-export declare const FLASHING_CELL_DEFAULT_DURATION_STATE_PROPERTY: string;
-export declare const CURRENT_THEME_STATE_PROPERTY: string;
-export declare const QUICK_SEARCH_TEXT_STATE_PROPERTY: string;
-export declare const QUICK_SEARCH_STYLE_STATE_PROPERTY: string;
-export declare const SMART_EDIT_VALUE_STATE_PROPERTY: string;
-export declare const SMART_EDIT_MATH_OPERATION_STATE_PROPERTY: string;
-export declare const SYSTEM_THEMES: AdaptableTheme[];
-export declare const VISUAL_DATA_REPORT = "Visual Data";
 export declare const ALL_DATA_REPORT = "All Data";
-export declare const CURRENT_DATA_REPORT = "Current Data";
-export declare const SELECTED_CELLS_REPORT = "Selected Cells";
-export declare const SELECTED_ROWS_REPORT = "Selected Rows";
+export declare const CURRENT_LAYOUT_REPORT = "Current Layout";
+export declare const SELECTED_DATA_REPORT = "Selected Data";
+export declare const SYSTEM_REPORT_NAMES: SystemReportName[];
+export declare const EXCEL_FORMAT_REPORT = "Excel";
+export declare const VISUAL_EXCEL_FORMAT_REPORT = "VisualExcel";
+export declare const CSV_FORMAT_REPORT = "CSV";
+export declare const JSON_FORMAT_REPORT = "JSON";
+export declare const SYSTEM_REPORT_FORMATS: SystemReportFormat[];
+export declare const SELECT_REPORT_STRING: string;
+export declare const SELECT_REPORT_FORMAT_STRING: string;
+export declare const DOWNLOAD_EXPORT_DESTINATION = "Download";
+export declare const CLIPBOARD_EXPORT_DESTINATION = "Clipboard";
+export declare const SYSTEM_EXPORT_DESTINATIONS: SystemExportDestination[];
 export declare const THEME_STYLE: string;
+export declare const LAYOUT_NEW_TABLE_TOOLTIP: string;
+export declare const LAYOUT_NEW_PIVOT_TOOLTIP: string;
+export declare const LAYOUT_NEW_TABLE_OR_PIVOT_TOOLTIP: string;
+export declare const LAYOUT_SAVE_TOOLTIP: string;
+export declare const LAYOUT_EDIT_TOOLTIP: string;
+export declare const LAYOUT_CLONE_TOOLTIP: string;
+export declare const LAYOUT_DELETE_TOOLTIP: string;
+export declare const STANDALONE_MODULE_POPUPS: AdaptableModule[];
+export declare const OBSERVABLE_EXPRESSION_ROW_ADDED: string;
+export declare const OBSERVABLE_EXPRESSION_ROW_REMOVED: string;

package/src/Utilities/Constants/GeneralConstants.js

@@ -1,147 +1,89 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DATE_INPUT_DATE_FORMAT = exports.LOADING_SCREEN_TEXT = exports.LOADING_SCREEN_TITLE = exports.LOADING_SCREEN_DELAY = exports.ENGLISH_VARIANT = exports.DASHBOARD_BUTTONS_LOCATION_RIGHT = exports.DASHBOARD_BUTTONS_LOCATION_LEFT = exports.QUICK_SEARCH_PLACEHOLDER = exports.NOTIFICATION_MAX_SYSTEM_MESSAGES = exports.NOTIFICATION_DURATION = exports.TOAST_TRANSITIONS_SLIDE = exports.TOAST_POSITIONS_BOTTOM_RIGHT = exports.RAW_VALUE_DATA_CHANGE_DETECTION_POLICY = exports.DEFAULT_DOUBLE_DISPLAY_VALUE = exports.DEFAULT_INTEGER_DISPLAY_VALUE = exports.DEFAULT_STRING_DISPLAY_VALUE = exports.BLANK_DISTINCT_COLUMN_VALUE = exports.DEFAULT_DATE_FORMAT_PATTERN_WITH_TIME = exports.DEFAULT_DATE_FORMAT_PATTERN = exports.ADAPTABLE_FDC3_ACTION_COLUMN_FRIENDLY_NAME = exports.ADAPTABLE_ROW_ACTION_BUTTONS_FRIENDLY_NAME = exports.ADAPTABLE_ROW_ACTION_BUTTONS = exports.AG_GRID_CHART_WINDOW = exports.AG_GRID_PIVOT_COLUMN = exports.AG_GRID_GROUPED_COLUMN = exports.GROUP_PATH_SEPARATOR = exports.HALF_SECOND = exports.AB_FDC3_COLUMN = exports.AB_ROW_ACTIONS_COLUMN = exports.AB_SPECIAL_COLUMN = exports.EMPTY_ARRAY = exports.EMPTY_STRING = exports.ALL_COLUMN_VALUES = exports.READ_ONLY_STYLE = exports.MENU_PREFIX = exports.AGGRID_TOOLPANEL_COLUMNS = exports.AGGRID_TOOLPANEL_FILTERS = exports.ADAPTABLE_TOOLPANEL_COMPONENT = exports.ADAPTABLE_TOOLPANEL_ID = exports.AG_GRID_CONTAINER_ID = exports.ADAPTABLE_CONTAINER_ID = exports.ADAPTABLE = exports.ADAPTABLE_ID = exports.USER_NAME = exports.OS_THEME = exports.DARK_THEME = exports.LIGHT_THEME = exports.DEFAULT_LAYOUT = exports.MISSING_COLUMN = exports.AUTOGENERATED_PK_COLUMN = void 0;
-exports.THEME_STYLE = exports.SELECTED_ROWS_REPORT = exports.SELECTED_CELLS_REPORT = exports.CURRENT_DATA_REPORT = exports.ALL_DATA_REPORT = exports.VISUAL_DATA_REPORT = exports.SYSTEM_THEMES = exports.SMART_EDIT_MATH_OPERATION_STATE_PROPERTY = exports.SMART_EDIT_VALUE_STATE_PROPERTY = exports.QUICK_SEARCH_STYLE_STATE_PROPERTY = exports.QUICK_SEARCH_TEXT_STATE_PROPERTY = exports.CURRENT_THEME_STATE_PROPERTY = exports.FLASHING_CELL_DEFAULT_DURATION_STATE_PROPERTY = exports.FLASHING_CELL_DEFAULT_DOWN_COLOR_STATE_PROPERTY = exports.FLASHING_CELL_DEFAULT_UP_COLOR_STATE_PROPERTY = exports.CURRENT_REPORT_STATE_PROPERTY = exports.CURRENT_LAYOUT_STATE_PROPERTY = exports.SUMMARY_OPERATION_STATE_PROPERTY = exports.ALERT_DEFAULT_SHOW_POPUP = exports.ALERT_DEFAULT_MESSAGE_TYPE = exports.PLUS_MINUS_DEFAULT_NUDGE_VALUE = exports.SERVER_VALIDATION_MESSAGE_TYPE = exports.SERVER_VALIDATION_HEADER = exports.DEFAULT_LIVE_REPORT_THROTTLE_TIME = exports.THEME_DEFAULT_CURRENT_THEME = exports.SYSTEM_DEFAULT_SYSTEM_STATUS_TYPE = exports.CELL_SUMMARY_DEFAULT_OPERATION = exports.QUICK_SEARCH_DEBOUNCE_TIME = exports.QUICK_SEARCH_DEFAULT_FORE_COLOR = exports.QUICK_SEARCH_DEFAULT_BACK_COLOR = exports.SYSTEM_STATUS_DEFAULT_MAX_MESSAGES_IN_STORE = exports.STANDALONE_MODULE_POPUPS = exports.ACCESS_LEVEL_FULL = exports.ACCESS_LEVEL_HIDDEN = exports.ACCESS_LEVEL_READONLY = exports.FDC3_ACTION_COLUMN_DEFAULT_HEADER_NAME = exports.FDC3_ACTION_COLUMN_DEFAULT_COLUMN_ID = exports.DISPLAY_ROW_GROUPS_CLOSED = exports.DISPLAY_ROW_GROUPS_EXPANDED = exports.DISPLAY_ROW_GROUPS_DYNAMIC = exports.SAVE_CHART_BEHAVIOUR_NONE = exports.SAVE_CHART_BEHAVIOUR_MANUAL = exports.SAVE_CHART_BEHAVIOUR_AUTO = exports.POPUP_TYPE_WINDOW = exports.POPUP_TYPE_MODAL = exports.ICON_CONFIGURATION = exports.FLASHING_TARGET_ROW = exports.FLASHING_TARGET_CELL = void 0;
-const Enums_1 = require("../../PredefinedConfig/Common/Enums");
-const UIHelper_1 = require("../../View/UIHelper");
+exports.LAYOUT_NEW_TABLE_OR_PIVOT_TOOLTIP = exports.LAYOUT_NEW_PIVOT_TOOLTIP = exports.LAYOUT_NEW_TABLE_TOOLTIP = exports.THEME_STYLE = exports.SYSTEM_EXPORT_DESTINATIONS = exports.CLIPBOARD_EXPORT_DESTINATION = exports.DOWNLOAD_EXPORT_DESTINATION = exports.SELECT_REPORT_FORMAT_STRING = exports.SELECT_REPORT_STRING = exports.SYSTEM_REPORT_FORMATS = exports.JSON_FORMAT_REPORT = exports.CSV_FORMAT_REPORT = exports.VISUAL_EXCEL_FORMAT_REPORT = exports.EXCEL_FORMAT_REPORT = exports.SYSTEM_REPORT_NAMES = exports.SELECTED_DATA_REPORT = exports.CURRENT_LAYOUT_REPORT = exports.ALL_DATA_REPORT = exports.SERVER_VALIDATION_MESSAGE_TYPE = exports.SERVER_VALIDATION_HEADER = exports.DEFAULT_LIVE_REPORT_THROTTLE_TIME = exports.MENU_SEPARATOR = exports.QUICK_SEARCH_DEBOUNCE_TIME = exports.DEFAULT_DOUBLE_DISPLAY_VALUE = exports.DEFAULT_INTEGER_DISPLAY_VALUE = exports.DEFAULT_STRING_DISPLAY_VALUE = exports.DEFAULT_DATE_FORMAT_PATTERN_WITH_TIME = exports.DEFAULT_DATE_FORMAT_PATTERN = exports.ADAPTABLE_FDC3_ACTION_COLUMN_FRIENDLY_NAME = exports.AG_GRID_CHART_WINDOW = exports.AG_GRID_PIVOT_COLUMN = exports.AG_GRID_GROUPED_COLUMN = exports.GROUP_PATH_SEPARATOR = exports.QUARTER_SECOND = exports.HALF_SECOND = exports.EMPTY_ARRAY = exports.EMPTY_STRING = exports.READ_ONLY_STYLE = exports.AGGRID_TOOLPANEL_COLUMNS = exports.AGGRID_TOOLPANEL_FILTERS = exports.ADAPTABLE_TOOLPANEL_COMPONENT = exports.ADAPTABLE_TOOLPANEL_ID = exports.ADAPTABLE_ID = exports.ADAPTABLE = exports.ERROR_LAYOUT = exports.OS_THEME = exports.DARK_THEME = exports.LIGHT_THEME = exports.MISSING_COLUMN = exports.AUTOGENERATED_PK_COLUMN = void 0;
+exports.OBSERVABLE_EXPRESSION_ROW_REMOVED = exports.OBSERVABLE_EXPRESSION_ROW_ADDED = exports.STANDALONE_MODULE_POPUPS = exports.LAYOUT_DELETE_TOOLTIP = exports.LAYOUT_CLONE_TOOLTIP = exports.LAYOUT_EDIT_TOOLTIP = exports.LAYOUT_SAVE_TOOLTIP = void 0;
 exports.AUTOGENERATED_PK_COLUMN = '__ADAPTABLE_PK__';
 exports.MISSING_COLUMN = ' [MISSING]';
-exports.DEFAULT_LAYOUT = 'Default Layout';
 exports.LIGHT_THEME = 'light';
 exports.DARK_THEME = 'dark';
 exports.OS_THEME = 'os';
-exports.USER_NAME = 'anonymous';
-exports.ADAPTABLE_ID = 'adaptable_id';
+exports.ERROR_LAYOUT = {
+    Name: 'Layout Error - No Layout Defined',
+    TableColumns: [],
+};
 exports.ADAPTABLE = 'AdapTable';
-exports.ADAPTABLE_CONTAINER_ID = 'adaptable';
-exports.AG_GRID_CONTAINER_ID = 'grid';
+exports.ADAPTABLE_ID = 'adaptable_id';
 exports.ADAPTABLE_TOOLPANEL_ID = 'adaptable';
 exports.ADAPTABLE_TOOLPANEL_COMPONENT = 'AdaptableToolPanel';
 // from https://www.ag-grid.com/javascript-data-grid/side-bar/#string-configuration
 exports.AGGRID_TOOLPANEL_FILTERS = 'filters';
 exports.AGGRID_TOOLPANEL_COLUMNS = 'columns';
-exports.MENU_PREFIX = 'ab_';
 exports.READ_ONLY_STYLE = 'ab_readonly';
-exports.ALL_COLUMN_VALUES = 'ALL_COLUMN_VALUES';
 exports.EMPTY_STRING = '';
 exports.EMPTY_ARRAY = [];
-exports.AB_SPECIAL_COLUMN = 'abSpecialColumn';
-exports.AB_ROW_ACTIONS_COLUMN = 'abRowActionsColumn';
-exports.AB_FDC3_COLUMN = 'abFdc3Column';
 exports.HALF_SECOND = 500;
+exports.QUARTER_SECOND = 250;
 exports.GROUP_PATH_SEPARATOR = '/';
 exports.AG_GRID_GROUPED_COLUMN = 'ag-Grid-AutoColumn';
 exports.AG_GRID_PIVOT_COLUMN = 'pivot_';
 exports.AG_GRID_CHART_WINDOW = 'AG Grid Window';
-exports.ADAPTABLE_ROW_ACTION_BUTTONS = 'adaptableRowActionButtons';
-exports.ADAPTABLE_ROW_ACTION_BUTTONS_FRIENDLY_NAME = '(ActionRowButtons)';
 exports.ADAPTABLE_FDC3_ACTION_COLUMN_FRIENDLY_NAME = '(FDC3ActionColumn)';
+// FIXME AFL - load this from DateInputOptions
 exports.DEFAULT_DATE_FORMAT_PATTERN = 'dd-MM-yyyy';
 exports.DEFAULT_DATE_FORMAT_PATTERN_WITH_TIME = 'dd-MM-yyyy HH:mm:ss';
-exports.BLANK_DISTINCT_COLUMN_VALUE = '[BLANKS]';
 exports.DEFAULT_STRING_DISPLAY_VALUE = 'Hello World';
 exports.DEFAULT_INTEGER_DISPLAY_VALUE = 12345;
 exports.DEFAULT_DOUBLE_DISPLAY_VALUE = 12345.6789;
-exports.RAW_VALUE_DATA_CHANGE_DETECTION_POLICY = 'rawValue';
-exports.TOAST_POSITIONS_BOTTOM_RIGHT = 'BottomRight';
-exports.TOAST_TRANSITIONS_SLIDE = 'Slide';
-exports.NOTIFICATION_DURATION = 3000;
-exports.NOTIFICATION_MAX_SYSTEM_MESSAGES = 100;
-exports.QUICK_SEARCH_PLACEHOLDER = 'Search';
-exports.DASHBOARD_BUTTONS_LOCATION_LEFT = 'left';
-exports.DASHBOARD_BUTTONS_LOCATION_RIGHT = 'right';
-// User Interface
-exports.ENGLISH_VARIANT = 'GB';
-exports.LOADING_SCREEN_DELAY = 200;
-exports.LOADING_SCREEN_TITLE = 'Initialising Grid';
-exports.LOADING_SCREEN_TEXT = 'Retrieving your settings and setting up the grid...';
-exports.DATE_INPUT_DATE_FORMAT = 'yyyy-MM-dd';
-// Flashing Cell
-exports.FLASHING_TARGET_CELL = 'cell';
-exports.FLASHING_TARGET_ROW = 'row';
-exports.ICON_CONFIGURATION = 'ConfigurationIcon';
-exports.POPUP_TYPE_MODAL = 'modal';
-exports.POPUP_TYPE_WINDOW = 'window';
-exports.SAVE_CHART_BEHAVIOUR_AUTO = 'auto';
-exports.SAVE_CHART_BEHAVIOUR_MANUAL = 'manual';
-exports.SAVE_CHART_BEHAVIOUR_NONE = 'none';
-// Layout
-exports.DISPLAY_ROW_GROUPS_DYNAMIC = 'dynamic';
-exports.DISPLAY_ROW_GROUPS_EXPANDED = 'expanded';
-exports.DISPLAY_ROW_GROUPS_CLOSED = 'closed';
-// FDC3 defaults
-exports.FDC3_ACTION_COLUMN_DEFAULT_COLUMN_ID = 'fdc3ActionColumn';
-exports.FDC3_ACTION_COLUMN_DEFAULT_HEADER_NAME = 'FDC3 Actions';
-// Entitlement Defaults
-exports.ACCESS_LEVEL_READONLY = 'ReadOnly';
-exports.ACCESS_LEVEL_HIDDEN = 'Hidden';
-exports.ACCESS_LEVEL_FULL = 'Full';
-// Standalone Popups
-exports.STANDALONE_MODULE_POPUPS = [
-    'BulkUpdate',
-    'SmartEdit',
-    'CellSummary',
-];
-/*
-Redux / State Defaults
-Try to put all our Redux / State defaults here and ONLY reference from here - avoid magic numbers / strings.
-Please!!!
-*/
-//System Status
-exports.SYSTEM_STATUS_DEFAULT_MAX_MESSAGES_IN_STORE = 100;
-// Quick Search
-exports.QUICK_SEARCH_DEFAULT_BACK_COLOR = (0, UIHelper_1.getHexForName)(UIHelper_1.LIGHT_YELLOW);
-exports.QUICK_SEARCH_DEFAULT_FORE_COLOR = (0, UIHelper_1.getHexForName)(UIHelper_1.BLACK);
 exports.QUICK_SEARCH_DEBOUNCE_TIME = 350;
-// Cells Summary
-exports.CELL_SUMMARY_DEFAULT_OPERATION = Enums_1.SummaryOperation.Sum;
-// export const SYSTEM_DEFAULT_SYSTEM_STATUS_COLOUR: 'Red' | 'Amber' | 'Green' | 'Blue' =
-//  StatusColour.Green;
-exports.SYSTEM_DEFAULT_SYSTEM_STATUS_TYPE = 'Info';
-// theme
-exports.THEME_DEFAULT_CURRENT_THEME = exports.LIGHT_THEME;
+exports.MENU_SEPARATOR = '-';
 // Live Report Throttle Time (used in OpenFin, IPushPull etc.)
 exports.DEFAULT_LIVE_REPORT_THROTTLE_TIME = 2000;
+// Validation
 exports.SERVER_VALIDATION_HEADER = 'Server Validation Message';
 exports.SERVER_VALIDATION_MESSAGE_TYPE = 'Info';
-/**
- * Object Factory
- */
-exports.PLUS_MINUS_DEFAULT_NUDGE_VALUE = 1;
-exports.ALERT_DEFAULT_MESSAGE_TYPE = 'Error';
-exports.ALERT_DEFAULT_SHOW_POPUP = true;
-/**
- * Constants for State (primarily for audit property events) - good idea?
- */
-exports.SUMMARY_OPERATION_STATE_PROPERTY = 'SummaryOperation';
-exports.CURRENT_LAYOUT_STATE_PROPERTY = 'CurrentLayout';
-exports.CURRENT_REPORT_STATE_PROPERTY = 'CurrentReport';
-exports.FLASHING_CELL_DEFAULT_UP_COLOR_STATE_PROPERTY = 'DefaultUpColor';
-exports.FLASHING_CELL_DEFAULT_DOWN_COLOR_STATE_PROPERTY = 'DefautDownColor';
-exports.FLASHING_CELL_DEFAULT_DURATION_STATE_PROPERTY = 'DefaultDuration';
-exports.CURRENT_THEME_STATE_PROPERTY = 'CurrentTheme';
-exports.QUICK_SEARCH_TEXT_STATE_PROPERTY = 'QuickSearchText';
-exports.QUICK_SEARCH_STYLE_STATE_PROPERTY = 'Style';
-exports.SMART_EDIT_VALUE_STATE_PROPERTY = 'SmartEditValue';
-exports.SMART_EDIT_MATH_OPERATION_STATE_PROPERTY = 'MathOperationz';
-// consts for Themes
-exports.SYSTEM_THEMES = [
-    {
-        Name: exports.LIGHT_THEME,
-        Description: 'Light Theme',
-    },
-    {
-        Name: exports.DARK_THEME,
-        Description: 'Dark Theme',
-    },
-    {
-        Name: exports.OS_THEME,
-        Description: 'OS Theme',
-    },
-];
-exports.VISUAL_DATA_REPORT = 'Visual Data';
+// System Report Name Constants
 exports.ALL_DATA_REPORT = 'All Data';
-exports.CURRENT_DATA_REPORT = 'Current Data';
-exports.SELECTED_CELLS_REPORT = 'Selected Cells';
-exports.SELECTED_ROWS_REPORT = 'Selected Rows';
+exports.CURRENT_LAYOUT_REPORT = 'Current Layout';
+exports.SELECTED_DATA_REPORT = 'Selected Data';
+exports.SYSTEM_REPORT_NAMES = [
+    exports.CURRENT_LAYOUT_REPORT,
+    exports.ALL_DATA_REPORT,
+    exports.SELECTED_DATA_REPORT,
+];
+// Systen Report Format Constants
+exports.EXCEL_FORMAT_REPORT = 'Excel';
+exports.VISUAL_EXCEL_FORMAT_REPORT = 'VisualExcel';
+exports.CSV_FORMAT_REPORT = 'CSV';
+exports.JSON_FORMAT_REPORT = 'JSON';
+exports.SYSTEM_REPORT_FORMATS = [
+    exports.EXCEL_FORMAT_REPORT,
+    exports.VISUAL_EXCEL_FORMAT_REPORT,
+    exports.CSV_FORMAT_REPORT,
+    exports.JSON_FORMAT_REPORT,
+];
+exports.SELECT_REPORT_STRING = 'Select Report';
+exports.SELECT_REPORT_FORMAT_STRING = 'Select Format';
+exports.DOWNLOAD_EXPORT_DESTINATION = 'Download';
+exports.CLIPBOARD_EXPORT_DESTINATION = 'Clipboard';
+exports.SYSTEM_EXPORT_DESTINATIONS = [
+    exports.DOWNLOAD_EXPORT_DESTINATION,
+    exports.CLIPBOARD_EXPORT_DESTINATION,
+];
+// Theme Constants
 exports.THEME_STYLE = `ab--theme-`;
+// Layout UI Constants
+exports.LAYOUT_NEW_TABLE_TOOLTIP = 'Create a new Table Layout';
+exports.LAYOUT_NEW_PIVOT_TOOLTIP = 'Create a new Pivot Layout';
+exports.LAYOUT_NEW_TABLE_OR_PIVOT_TOOLTIP = 'Create a new Layout';
+exports.LAYOUT_SAVE_TOOLTIP = 'Save Changes to Current Layout';
+exports.LAYOUT_EDIT_TOOLTIP = 'Edit Layout';
+exports.LAYOUT_CLONE_TOOLTIP = 'Clone Layout';
+exports.LAYOUT_DELETE_TOOLTIP = 'Delete Layout';
+// Standalone Popups
+exports.STANDALONE_MODULE_POPUPS = [
+    'BulkUpdate',
+    'SmartEdit',
+    'CellSummary',
+];
+exports.OBSERVABLE_EXPRESSION_ROW_ADDED = 'ROW_ADDED';
+exports.OBSERVABLE_EXPRESSION_ROW_REMOVED = 'ROW_REMOVED';