@adaptabletools/adaptable-cjs 23.0.0-canary.1 → 23.0.0-canary.10

package/src/Utilities/Helpers/Helper.js

@@ -12,9 +12,6 @@ exports.copyToClipboard = copyToClipboard;
 exports.returnItemCount = returnItemCount;
 exports.isInputNullOrEmpty = isInputNullOrEmpty;
 exports.isInputNotNullOrEmpty = isInputNotNullOrEmpty;
-exports.roundNumber = roundNumber;
-exports.roundNumberTo4dp = roundNumberTo4dp;
-exports.clamp = clamp;
 exports.extractColsFromText = extractColsFromText;
 exports.replaceAll = replaceAll;
 exports.extractContextKeysFromText = extractContextKeysFromText;
@@ -161,38 +158,6 @@ function isInputNullOrEmpty(itemToCheck) {
 function isInputNotNullOrEmpty(itemToCheck) {
     return !isInputNullOrEmpty(itemToCheck);
 }
-function roundNumber(numberToRound, decimalPlaces) {
-    switch (decimalPlaces) {
-        case 1:
-            return Math.round(numberToRound * 10) / 10;
-        case 2:
-            return Math.round(numberToRound * 100) / 100;
-        case 3:
-            return Math.round(numberToRound * 1000) / 1000;
-        case 4:
-            return Math.round(numberToRound * 10000) / 10000;
-        case 5:
-            return Math.round(numberToRound * 100000) / 100000;
-        case 6:
-            return Math.round(numberToRound * 1000000) / 1000000;
-    }
-}
-function roundNumberTo4dp(numberToRound) {
-    return roundNumber(numberToRound, 4);
-}
-// putting this here to remove lodash clamp which seems to cause an issue
-function clamp(value, boundOne, boundTwo) {
-    if (!boundTwo) {
-        return Math.max(value, boundOne) === boundOne ? value : boundOne;
-    }
-    else if (Math.min(value, boundOne) === value) {
-        return boundOne;
-    }
-    else if (Math.max(value, boundTwo) === value) {
-        return boundTwo;
-    }
-    return value;
-}
 function extractColsFromText(text) {
     // rowData.columnName => columnName
     const regex = /\[rowData\.(.*?)\]/g;
@@ -233,9 +198,6 @@ exports.Helper = {
     returnItemCount,
     isInputNullOrEmpty,
     isInputNotNullOrEmpty,
-    roundNumber,
-    roundNumberTo4dp,
-    clamp,
     extractColsFromText,
     replaceAll,
     extractContextKeysFromText,

package/src/Utilities/Helpers/{QuickSearchStyleHelper.js → QuickSearchHelper.js}

@@ -5,10 +5,9 @@ exports.resolveQuickSearchTextMatchStyle = resolveQuickSearchTextMatchStyle;
 exports.resolveQuickSearchCellMatchStyle = resolveQuickSearchCellMatchStyle;
 exports.resolveQuickSearchCurrentTextMatchStyle = resolveQuickSearchCurrentTextMatchStyle;
 exports.applyQuickSearchFindCssVars = applyQuickSearchFindCssVars;
-const tslib_1 = require("tslib");
 const QuickSearchRedux_1 = require("../../Redux/ActionsReducers/QuickSearchRedux");
 const StyleHelper_1 = require("./StyleHelper");
-const kebabCase_1 = tslib_1.__importDefault(require("../utils/kebabCase"));
+const StringExtensions_1 = require("../Extensions/StringExtensions");
 const QUICK_SEARCH_FIND_CSS_KEYS = [
     'backgroundColor',
     'color',
@@ -79,6 +78,6 @@ function applyQuickSearchFindCssVars(container, quickSearchState) {
 }
 function applyQuickSearchFindCssVarsForPrefix(container, prefix, css) {
     QUICK_SEARCH_FIND_CSS_KEYS.forEach((key) => {
-        container.style.setProperty(`--ab-qs-${prefix}-${(0, kebabCase_1.default)(key)}`, css[key] ?? '');
+        container.style.setProperty(`--ab-qs-${prefix}-${(0, StringExtensions_1.kebabCase)(key)}`, css[key] ?? '');
     });
 }

package/src/Utilities/Helpers/{ScheduleHelper.d.ts → Scheduling/ScheduleHelper.d.ts}

@@ -1,4 +1,4 @@
-import { Schedule, Weekday } from '../../AdaptableState/Common/Schedule';
+import { Schedule, Weekday } from '../../../AdaptableState/Common/Schedule';
 export type ScheduleRecurrencePreset = 'daily' | 'weekdays' | 'selectedDays' | 'monthly' | 'custom';
 export declare function buildCronExpression(preset: ScheduleRecurrencePreset, hour: number, minute: number, options?: {
     days?: Weekday[];

package/src/Utilities/Helpers/{ScheduleHelper.js → Scheduling/ScheduleHelper.js}

@@ -11,7 +11,7 @@ exports.getScheduleDescription = getScheduleDescription;
 exports.isValidCronExpression = isValidCronExpression;
 const tslib_1 = require("tslib");
 const cron_parser_1 = require("cron-parser");
-const StringExtensions_1 = tslib_1.__importDefault(require("../Extensions/StringExtensions"));
+const StringExtensions_1 = tslib_1.__importDefault(require("../../Extensions/StringExtensions"));
 const WEEKDAY_TO_CRON = {
     Sunday: 0,
     Monday: 1,
@@ -199,6 +199,8 @@ function getScheduleDescription(schedule) {
         }
         case 'monthly':
             return `Monthly on day ${dayOfMonth} ${time}`;
+        case 'custom':
+            return schedule.CronExpression?.trim() || 'Custom Cron';
         default:
             return `${schedule.CronExpression ?? 'Custom'} ${time}`;
     }

package/src/Utilities/Helpers/{ScheduleJobManager.d.ts → Scheduling/ScheduleJobManager.d.ts}

@@ -1,4 +1,4 @@
-import { Schedule } from '../../AdaptableState/Common/Schedule';
+import { Schedule } from '../../../AdaptableState/Common/Schedule';
 export interface ScheduleJobManagerConfig<T> {
     getActiveItems: () => T[];
     getSchedule: (item: T) => Schedule | undefined;

package/src/Utilities/Helpers/{ScheduleJobRunner.d.ts → Scheduling/ScheduleJobRunner.d.ts}

@@ -1,4 +1,4 @@
-import { Schedule } from '../../AdaptableState/Common/Schedule';
+import { Schedule } from '../../../AdaptableState/Common/Schedule';
 export interface ScheduleJob {
     cancel: () => void;
 }

package/src/Utilities/Helpers/{ScheduledAlertHelper.d.ts → Scheduling/ScheduledAlertHelper.d.ts}

@@ -1,4 +1,4 @@
-import { AlertButtonForm, AlertDefinition, RuleAlertProperties, RuleBasedAlertDefinition, ScheduledAlertDefinition } from '../../AdaptableState/AlertState';
+import { AlertButtonForm, AlertDefinition, RuleAlertProperties, RuleBasedAlertDefinition, ScheduledAlertDefinition } from '../../../AdaptableState/AlertState';
 export declare function isScheduledAlertDefinition(alert: AlertDefinition | undefined | null): alert is ScheduledAlertDefinition;
 export declare function isRuleBasedAlertDefinition(alert: AlertDefinition | undefined | null): alert is RuleBasedAlertDefinition;
 export declare function getRuleAlertProperties(alert: AlertDefinition | undefined | null): RuleAlertProperties | undefined;

package/src/Utilities/Helpers/{ScheduledAlertHelper.js → Scheduling/ScheduledAlertHelper.js}

@@ -8,10 +8,10 @@ exports.getScheduledAlertNotificationForm = getScheduledAlertNotificationForm;
 exports.scheduledAlertIncludeSuspendButton = scheduledAlertIncludeSuspendButton;
 exports.CreateEmptyScheduledAlertDefinition = CreateEmptyScheduledAlertDefinition;
 const tslib_1 = require("tslib");
-const ObjectFactory_1 = tslib_1.__importDefault(require("../ObjectFactory"));
-const GeneralConstants_1 = require("../Constants/GeneralConstants");
-const ObjectDefaultConstants_1 = require("../Constants/ObjectDefaultConstants");
-const Uuid_1 = require("../../AdaptableState/Uuid");
+const ObjectFactory_1 = tslib_1.__importDefault(require("../../ObjectFactory"));
+const GeneralConstants_1 = require("../../Constants/GeneralConstants");
+const ObjectDefaultConstants_1 = require("../../Constants/ObjectDefaultConstants");
+const Uuid_1 = require("../../../AdaptableState/Uuid");
 function isScheduledAlertDefinition(alert) {
     return alert != null && 'Schedule' in alert;
 }

package/src/Utilities/Helpers/{ScheduledJobsMiddlewareHelper.d.ts → Scheduling/ScheduledJobsMiddlewareHelper.d.ts}

@@ -1,3 +1,3 @@
-import { IAdaptable } from '../../AdaptableInterfaces/IAdaptable';
+import { IAdaptable } from '../../../AdaptableInterfaces/IAdaptable';
 export declare function refreshScheduledAlertJobs(adaptable: IAdaptable): void;
 export declare function refreshScheduledReportJobs(adaptable: IAdaptable): void;

package/src/Utilities/Helpers/{ScheduledJobsMiddlewareHelper.js → Scheduling/ScheduledJobsMiddlewareHelper.js}

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.refreshScheduledAlertJobs = refreshScheduledAlertJobs;
 exports.refreshScheduledReportJobs = refreshScheduledReportJobs;
 const tslib_1 = require("tslib");
-const ModuleConstants = tslib_1.__importStar(require("../Constants/ModuleConstants"));
+const ModuleConstants = tslib_1.__importStar(require("../../Constants/ModuleConstants"));
 function refreshScheduledAlertJobs(adaptable) {
     const alertModule = adaptable.adaptableModules.get(ModuleConstants.AlertModuleId);
     alertModule?.setUpScheduledAlertJobs?.();

package/src/Utilities/Helpers/{ScheduledReportHelper.d.ts → Scheduling/ScheduledReportHelper.d.ts}

@@ -1,4 +1,4 @@
-import { ExportState, ReportNameType, ReportSchedule } from '../../AdaptableState/ExportState';
+import { ExportState, ReportNameType, ReportSchedule } from '../../../AdaptableState/ExportState';
 export declare function reportScheduleToSchedule(reportSchedule: {
     ReportName?: string;
     ScheduleType?: string;

package/src/Utilities/Helpers/{ScheduledReportHelper.js → Scheduling/ScheduledReportHelper.js}

@@ -8,7 +8,7 @@ exports.exportStateNeedsScheduleUuids = exportStateNeedsScheduleUuids;
 exports.ensureExportStateSchedulesUuids = ensureExportStateSchedulesUuids;
 exports.replaceScheduledReportScheduleInList = replaceScheduledReportScheduleInList;
 exports.countSchedulesForReport = countSchedulesForReport;
-const Uuid_1 = require("../../AdaptableState/Uuid");
+const Uuid_1 = require("../../../AdaptableState/Uuid");
 function reportScheduleToSchedule(reportSchedule) {
     const { ReportName: reportName, ScheduleType: _scheduleType, ...schedule } = reportSchedule;
     return {

package/src/Utilities/Helpers/SettingsPanelHelper.d.ts

@@ -0,0 +1,5 @@
+import { AdaptableApi } from '../../Api/AdaptableApi';
+import { SettingsPanelNavigation, SettingsPanelNavigationGroup, SettingsPanelOptions } from '../../AdaptableOptions/SettingsPanelOptions';
+export declare const DEFAULT_SETTINGS_PANEL_NAVIGATION_GROUPS: SettingsPanelNavigationGroup[];
+export declare const buildDefaultSettingsPanelNavigation: (customPanelNames?: string[]) => SettingsPanelNavigation;
+export declare const resolveSettingsPanelNavigation: (api: AdaptableApi, settingsPanelOptions: SettingsPanelOptions) => SettingsPanelNavigation;

package/src/Utilities/Helpers/SettingsPanelHelper.js

@@ -0,0 +1,66 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.resolveSettingsPanelNavigation = exports.buildDefaultSettingsPanelNavigation = exports.DEFAULT_SETTINGS_PANEL_NAVIGATION_GROUPS = void 0;
+exports.DEFAULT_SETTINGS_PANEL_NAVIGATION_GROUPS = [
+    {
+        label: 'Grid & UI',
+        items: ['GridInfo', 'ColumnInfo', 'Dashboard', 'ToolPanel', 'StatusBar', 'Theme'],
+    },
+    {
+        label: 'Layout',
+        items: ['Layout', 'CalculatedColumn', 'CustomSort', 'Charting'],
+    },
+    {
+        label: 'Formatting',
+        items: ['FormatColumn', 'StyledColumn', 'FlashingCell'],
+    },
+    {
+        label: 'Filtering & Search',
+        items: ['QuickSearch', 'GridFilter', 'ColumnFilter', 'DataSet', 'NamedQuery'],
+    },
+    {
+        label: 'Notes & Annotations',
+        items: ['Alert', 'Note', 'Comment', 'FreeTextColumn', 'SystemStatus'],
+    },
+    {
+        label: 'Export & Import',
+        items: ['Export', 'DataImport'],
+    },
+    {
+        label: 'ֵEditing',
+        items: ['PlusMinus', 'Shortcut', 'DataChangeHistory'],
+    },
+    {
+        label: 'Administration',
+        items: ['TeamSharing', 'StateManagement'],
+    },
+];
+const buildDefaultSettingsPanelNavigation = (customPanelNames = []) => {
+    const groups = exports.DEFAULT_SETTINGS_PANEL_NAVIGATION_GROUPS.map((group) => ({
+        label: group.label,
+        items: [...group.items],
+    }));
+    if (customPanelNames.length) {
+        groups.push({
+            label: 'Custom Panels',
+            items: [...customPanelNames],
+        });
+    }
+    return { groups };
+};
+exports.buildDefaultSettingsPanelNavigation = buildDefaultSettingsPanelNavigation;
+const cloneSettingsPanelNavigation = (navigation) => ({
+    groups: navigation.groups.map((group) => ({
+        label: group.label,
+        items: [...group.items],
+    })),
+});
+const resolveSettingsPanelNavigation = (api, settingsPanelOptions) => {
+    const defaultNavigation = (0, exports.buildDefaultSettingsPanelNavigation)(settingsPanelOptions.customSettingsPanels?.map((panel) => panel.name) ?? []);
+    if (!settingsPanelOptions.navigation) {
+        return defaultNavigation;
+    }
+    const context = api.internalApi.buildBaseContext();
+    return settingsPanelOptions.navigation(context, cloneSettingsPanelNavigation(defaultNavigation));
+};
+exports.resolveSettingsPanelNavigation = resolveSettingsPanelNavigation;

package/src/Utilities/Helpers/StyleHelper.d.ts

@@ -48,3 +48,21 @@ export declare const toStyle: (style?: AdaptableStyle) => {
     borderStyle: string;
 };
 export declare const getVariableColor: (variable: string) => string;
+/**
+ * Default surface colour assumed to sit *behind* a semi-transparent cell tint
+ * when computing auto-contrast text. Gradient cells paint a base colour at a
+ * value-driven alpha, so the colour the user actually perceives is that tint
+ * composited over the grid cell background (white in the default light theme).
+ */
+export declare const DEFAULT_CELL_SURFACE_COLOR = "#ffffff";
+/**
+ * Picks a readable text colour (near-black or white) for a cell whose
+ * background is `baseColor` painted at `alpha` over `surfaceColor`.
+ *
+ * The tint must be composited over the surface *before* measuring luminance:
+ * `tinycolor.getLuminance()` ignores the alpha channel, so measuring the raw
+ * base colour would yield the same result for a faint cell and a fully-opaque
+ * one — making auto-contrast text identical on every row instead of adapting
+ * per cell.
+ */
+export declare const getAutoContrastTextColor: (baseColor: string, alpha: number, surfaceColor?: string) => string;

package/src/Utilities/Helpers/StyleHelper.js

@@ -1,6 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getVariableColor = exports.toStyle = exports.convertCSSAbsoluteFontSizeToPt = exports.convertAdaptableStyleToCSS = exports.sanitizeStyle = exports.normalizeStyleForAgGrid = exports.AgGridCellStyleProperties = exports.omitCellBoxStyle = exports.omitCellFontStyle = exports.pickCellBoxStyle = exports.pickCellFontStyle = exports.hasCellBoxStyle = exports.hasCellFontStyle = exports.CELL_BOX_STYLE_KEYS = exports.CELL_FONT_STYLE_KEYS = void 0;
+exports.getAutoContrastTextColor = exports.DEFAULT_CELL_SURFACE_COLOR = exports.getVariableColor = exports.toStyle = exports.convertCSSAbsoluteFontSizeToPt = exports.convertAdaptableStyleToCSS = exports.sanitizeStyle = exports.normalizeStyleForAgGrid = exports.AgGridCellStyleProperties = exports.omitCellBoxStyle = exports.omitCellFontStyle = exports.pickCellBoxStyle = exports.pickCellFontStyle = exports.hasCellBoxStyle = exports.hasCellFontStyle = exports.CELL_BOX_STYLE_KEYS = exports.CELL_FONT_STYLE_KEYS = void 0;
+const tslib_1 = require("tslib");
+const tinycolor2_1 = tslib_1.__importDefault(require("tinycolor2"));
 const EnumExtensions_1 = require("../Extensions/EnumExtensions");
 /**
  * Keys belonging to the "Font" slice (text rendering + alignment).
@@ -230,3 +232,30 @@ const getVariableColor = (variable) => {
     return getComputedStyle(document.documentElement).getPropertyValue(match[1]).trim();
 };
 exports.getVariableColor = getVariableColor;
+/**
+ * Default surface colour assumed to sit *behind* a semi-transparent cell tint
+ * when computing auto-contrast text. Gradient cells paint a base colour at a
+ * value-driven alpha, so the colour the user actually perceives is that tint
+ * composited over the grid cell background (white in the default light theme).
+ */
+exports.DEFAULT_CELL_SURFACE_COLOR = '#ffffff';
+/**
+ * Luminance above which a (composited, opaque) background is considered "light"
+ * enough to need dark text.
+ */
+const AUTO_CONTRAST_LUMINANCE_THRESHOLD = 0.45;
+/**
+ * Picks a readable text colour (near-black or white) for a cell whose
+ * background is `baseColor` painted at `alpha` over `surfaceColor`.
+ *
+ * The tint must be composited over the surface *before* measuring luminance:
+ * `tinycolor.getLuminance()` ignores the alpha channel, so measuring the raw
+ * base colour would yield the same result for a faint cell and a fully-opaque
+ * one — making auto-contrast text identical on every row instead of adapting
+ * per cell.
+ */
+const getAutoContrastTextColor = (baseColor, alpha, surfaceColor = exports.DEFAULT_CELL_SURFACE_COLOR) => {
+    const composited = tinycolor2_1.default.mix(surfaceColor, baseColor, alpha * 100);
+    return composited.getLuminance() > AUTO_CONTRAST_LUMINANCE_THRESHOLD ? '#111111' : '#ffffff';
+};
+exports.getAutoContrastTextColor = getAutoContrastTextColor;

package/src/Utilities/Helpers/StyledColumns/BarStylesHelper.d.ts

@@ -0,0 +1,63 @@
+import { BarStyleCellTextHorizontalAlignment, BarStyleCellTextLayout, BarStyleCellTextPlacement, BarStyleCellTextProperties, BarStyleCellTextVerticalAlignment } from '../../../AdaptableState/StyledColumns/Common/BarStyleProperties';
+import { CellTextOption, CellTextOptions } from '../../../AdaptableState/StyledColumns/Common/CellTextOptions';
+export type BarStyleCellTextLabels = {
+    cellValue?: string;
+    percentage?: string;
+};
+export declare const resolveBarStyleCellTextLayout: (props: BarStyleCellTextProperties | undefined) => BarStyleCellTextLayout;
+/** True when any value is configured for display. */
+export declare const hasBarStyleCellTextConfigured: (props: BarStyleCellTextProperties | undefined) => boolean;
+/** Set of value tokens that currently have a placement. */
+export declare const getActiveBarStyleCellTextTokens: (props: BarStyleCellTextProperties | undefined) => CellTextOptions;
+export declare const mergeBarStyleCellTextProperties: (current: BarStyleCellTextProperties | undefined, patch: Partial<BarStyleCellTextProperties>) => BarStyleCellTextProperties | undefined;
+/**
+ * Set or clear a value's placement. Passing `placement: undefined` removes the value.
+ */
+export declare const setBarStyleCellTextPlacement: (current: BarStyleCellTextProperties | undefined, token: CellTextOption, placement: BarStyleCellTextPlacement | undefined) => BarStyleCellTextProperties | undefined;
+/**
+ * Patch a single axis of a value's placement (creating the value with defaults if
+ * needed). Used by the wizard's placement pickers.
+ */
+export declare const patchBarStyleCellTextPlacement: (current: BarStyleCellTextProperties | undefined, token: CellTextOption, patch: Partial<BarStyleCellTextPlacement>) => BarStyleCellTextProperties | undefined;
+/**
+ * Toggle whether a value is displayed. When turning on a previously-hidden
+ * value we use the default placement (Left / Below).
+ */
+export declare const toggleBarStyleCellTextToken: (current: BarStyleCellTextProperties | undefined, token: CellTextOption, show: boolean) => {
+    CellTextProperties: BarStyleCellTextProperties | undefined;
+};
+export declare const buildBarStyleCellTextLabels: (props: BarStyleCellTextProperties | undefined, cellValueLabel: string | undefined, percentageLabel: string | undefined) => BarStyleCellTextLabels;
+export declare const hasBarStyleCellTextLabels: (labels: BarStyleCellTextLabels) => boolean;
+/** Join active labels with a space, Cell Value first then Percent Value. */
+export declare const joinBarStyleCellTextLabels: (labels: BarStyleCellTextLabels) => string;
+export type BarStyleCellTextSlotEntry = {
+    vertical: BarStyleCellTextVerticalAlignment;
+    horizontal: BarStyleCellTextHorizontalAlignment;
+    /** Labels in render order (Cell Value first, then Percent Value). */
+    parts: string[];
+    /** The joined text, ready to render. */
+    text: string;
+};
+/**
+ * Resolve which placements are populated and what text goes in each cell of
+ * the 3 × 3 grid. Empty slots are omitted. Two values landing on the same
+ * (vertical, horizontal) slot are concatenated with a single space, Cell
+ * Value before Percent Value.
+ */
+export declare const resolveBarStyleCellTextSlots: (props: BarStyleCellTextProperties | undefined, labels: BarStyleCellTextLabels) => BarStyleCellTextSlotEntry[];
+export type BarStyleCellTextSlotPresence = {
+    hasAbove: boolean;
+    hasBelow: boolean;
+    hasMerged: boolean;
+};
+export declare const getBarStyleCellTextSlotPresence: (props: BarStyleCellTextProperties | undefined) => BarStyleCellTextSlotPresence;
+export declare const formatBarStyleCellTextLayoutSummary: (layout: BarStyleCellTextLayout) => string | undefined;
+export type MountBarStyleCellTextArgs = {
+    wrapperEl: HTMLElement;
+    mergedOverlayEl?: HTMLElement;
+    textClassName: string;
+    cellTextProperties?: BarStyleCellTextProperties;
+    labels: BarStyleCellTextLabels;
+    mergedPointerEventsNone?: boolean;
+};
+export declare const mountBarStyleCellText: (args: MountBarStyleCellTextArgs) => void;