@adaptabletools/adaptable 23.0.4 → 23.0.5-canary.0

package/src/Utilities/Extensions/ObjectExtensions.js

@@ -1,12 +1,3 @@
-/**
- * Returns a new object with the property updated.
- * The property is identified by the path.
- *
- * @param obj Object
- * @param path path to the property
- * @param value new property value
- * @returns
- */
 export function setInPath(obj, path, value) {
     if (path.length === 1) {
         return {
@@ -34,20 +25,10 @@ export const diff = (obj1, obj2) => {
     }
     return changed;
 };
-/**
- * Checks if `value` is the language type of Object.
- * (e.g. arrays, functions, objects, regexes, new Number(0), and new String(''))
- * Drop-in replacement for lodash/isObject.
- */
 export function isObject(value) {
     const type = typeof value;
     return value != null && (type === 'object' || type === 'function');
 }
-/**
- * Checks if `value` is a plain object, that is, an object created by the
- * Object constructor or one with a [[Prototype]] of null.
- * Drop-in replacement for lodash/isPlainObject.
- */
 export function isPlainObject(value) {
     if (value === null || value === undefined || typeof value !== 'object') {
         return false;
@@ -58,10 +39,6 @@ export function isPlainObject(value) {
     }
     return proto === Object.prototype;
 }
-/**
- * Performs a deep comparison between two values to determine if they are equivalent.
- * Drop-in replacement for lodash/isEqual.
- */
 export function isEqual(value, other) {
     return _baseIsEqual(value, other, new Map());
 }
@@ -124,7 +101,6 @@ function _baseIsEqual(a, b, seen) {
         }
         return true;
     }
-    // Unordered deep comparison for Sets, matching lodash behaviour
     if (a instanceof Set && b instanceof Set) {
         if (a.size !== b.size) {
             return false;
@@ -171,12 +147,6 @@ function _baseIsEqual(a, b, seen) {
     }
     return true;
 }
-/**
- * Like `cloneDeep` except that it accepts a customizer which is invoked to
- * produce the cloned value. If the customizer returns `undefined`, cloning is
- * handled by the method instead.
- * Drop-in replacement for lodash/cloneDeepWith.
- */
 export function cloneDeepWith(value, customizer) {
     return _baseCloneDeep(value, customizer, new Map());
 }
@@ -291,12 +261,6 @@ function _baseMergeWith(target, source, customizer) {
     }
     return target;
 }
-/**
- * Like `merge` except that it accepts a customizer which is invoked to produce
- * the merged values of the destination and source properties. If the customizer
- * returns `undefined`, merging is handled by the method instead.
- * Drop-in replacement for lodash/mergeWith.
- */
 export function mergeWith(target, ...args) {
     const customizer = args[args.length - 1];
     const sources = args.slice(0, -1);

package/src/Utilities/Extensions/StringExtensions.js

@@ -22,15 +22,11 @@ export function IsNullOrEmptyOrWhiteSpace(stringToCheck) {
 export function IsNotNullOrEmptyOrWhiteSpace(stringToCheck) {
     return !IsNullOrEmptyOrWhiteSpace(stringToCheck);
 }
-// clone of A Grid's implementation
-// https://github.com/ag-grid/ag-grid/blob/a5c3d9f56350271ab7e8d42d72aaf5314672719a/packages/ag-grid-community/src/columns/columnNameService.ts#L14
 export function CamelCaseToHumanText(camelCase) {
     if (!camelCase || camelCase == null) {
         return null;
     }
-    // either split on a lowercase followed by uppercase ie  asHereTo -> as Here To
     const rex = /([a-z])([A-Z])/g;
-    // or starts with uppercase and we take all expect the last which is assumed to be part of next word if followed by lowercase HEREToThere -> HERE To There
     const rexCaps = /([A-Z]+)([A-Z])([a-z])/g;
     const words = camelCase
         .replace(rex, '$1 $2')
@@ -92,25 +88,15 @@ export function UnescapeHtmlEntities(str) {
     return preparedStr;
 }
 export function ReplaceAllOccurencesExceptLastOne(str, searchTerm, replacement) {
-    // Find the index of the last occurrence of the search string
     const lastIndex = str.lastIndexOf(searchTerm);
-    // If the string is not found, return the original string
     if (lastIndex === -1) {
         return str;
     }
-    // Slice the string into two parts: before and after the last occurrence
     const partBeforeLast = str.slice(0, lastIndex);
     const partAfterLast = str.slice(lastIndex);
-    // Replace all occurrences in the first part
     const replacedPart = partBeforeLast.replaceAll(searchTerm, replacement);
-    // Recombine the modified first part with the untouched second part
     return replacedPart + partAfterLast;
 }
-/**
- * Splits a string into words: handles camelCase, PascalCase, UPPER_CASE,
- * UPPER_SNAKE_CASE, snake_case, kebab-case, spaces, and dot.notation.
- * Shared helper used by `kebabCase`, `startCase`, and `sentenceCase`.
- */
 export function words(str) {
     const matches = str.match(/[A-Z]?[a-z]+|[A-Z]+(?=[A-Z][a-z]|\d|$|[^a-zA-Z0-9])|[A-Z]|[0-9]+/g);
     return matches || [];
@@ -118,25 +104,12 @@ export function words(str) {
 function _capitalizeWord(word) {
     return word.charAt(0).toUpperCase() + word.slice(1).toLowerCase();
 }
-/**
- * Converts string to kebab-case.
- * Drop-in replacement for lodash/kebabCase.
- */
 export function kebabCase(string) {
     return words(string).map((w) => w.toLowerCase()).join('-');
 }
-/**
- * Converts string to Start Case.
- * Drop-in replacement for lodash/startCase.
- */
 export function startCase(string) {
     return words(string).map(_capitalizeWord).join(' ');
 }
-/**
- * Converts string to Sentence case.
- * Splits on camelCase, PascalCase, dots, underscores, hyphens, and non-alphanumeric characters.
- * Drop-in replacement for the sentence-case package.
- */
 export function sentenceCase(input) {
     const parts = words(input);
     if (parts.length === 0) {

package/src/Utilities/Helpers/ActionColumnHelper.js

@@ -24,10 +24,6 @@ function getStaticButtonLabel(button) {
 function hasStaticIcon(button) {
     return Boolean(button.icon && typeof button.icon !== 'function');
 }
-/**
- * Estimates Action Column width from design-time button definitions.
- * Dynamic labels/icons (functions) are not measured — use an explicit `width` instead.
- */
 export function calculateActionColumnWidth(actionColumn, buttons) {
     const settings = actionColumn.actionColumnSettings ?? {};
     if (settings.width != null) {

package/src/Utilities/Helpers/AdaptableHelper.js

@@ -10,9 +10,6 @@ const GET_CURRENT_VERSION = () => {
         : packageJson.version) ?? packageJson.version);
 };
 export function addUuidsToInitialState(initialState) {
-    // Collect only the objects that should receive metadata:
-    // module state objects and their direct array items (root-level AdaptableObjects).
-    // Deeply nested sub-objects (e.g. CellRanges, ColumnComparison) are excluded.
     const objectsToEnrich = new Set();
     for (const moduleKey in initialState) {
         const moduleState = initialState[moduleKey];
@@ -24,8 +21,6 @@ export function addUuidsToInitialState(initialState) {
                     for (const item of value) {
                         if (isPlainObject(item)) {
                             objectsToEnrich.add(item);
-                            // ColumnFilters are nested inside Layouts but need Uuid
-                            // for identification (suspend/unsuspend, edit vs add, etc.)
                             if (Array.isArray(item.ColumnFilters)) {
                                 for (const filter of item.ColumnFilters) {
                                     if (isPlainObject(filter)) {
@@ -52,8 +47,6 @@ export function addUuidsToInitialState(initialState) {
     return cloneDeepWith(initialState, customizer);
 }
 export function getAccessLevelForObject(adaptableObject, moduleAccessLevel) {
-    // we always return the Module Access Level unless the following condition is met:
-    // the object prpoerty has been set and set to true and the Module entitlement is full
     if (moduleAccessLevel == ACCESS_LEVEL_FULL &&
         adaptableObject &&
         adaptableObject.IsReadOnly &&
@@ -123,7 +116,6 @@ export function removeAdaptableObjectPrimitives(adaptableObject) {
     sanitiseObject(clonedObject);
     return clonedObject;
 }
-// pretty primitive type guard for AdaptableObject, but currently there is no better/safer way
 export function isAdaptableObject(object) {
     return object != undefined && typeof object['Uuid'] === 'string';
 }

package/src/Utilities/Helpers/DateHelper.js

@@ -4,11 +4,6 @@ import { AdaptableLogger } from '../../agGrid/AdaptableLogger';
 export const isValidDate = (date) => {
     return date instanceof Date && !isNaN(date.getTime());
 };
-/**
- * Checks if the data contains a value that represents a valid date.
- *
- * @param data any kind of data
- */
 export const isValueValidDate = (data) => {
     if (!data || typeof data === 'boolean') {
         return false;
@@ -23,9 +18,6 @@ export const parseToISO = (date, dateFormat) => {
     const dateInstance = parseDateValue(date, dateFormat);
     return isValidDate(dateInstance) ? dateToISO(dateInstance) : '';
 };
-// !!!
-// AFL: ideally we should NEVER call directly this method, but use the AdaptableInternalApi.parseDateValue() instead
-// we should refactor this with the first opportunity
 export const parseDateValue = (dateValue, dateFormat) => {
     if (dateValue == undefined || (typeof dateValue === 'string' && dateValue.trim() === '')) {
         return undefined;
@@ -39,7 +31,6 @@ export const parseDateValue = (dateValue, dateFormat) => {
             dateInstance = new Date(dateValue);
         }
         else {
-            // typeof dateValue === 'string'
             if (dateFormat) {
                 dateInstance = parse(dateValue, dateFormat, new Date());
             }
@@ -47,7 +38,6 @@ export const parseDateValue = (dateValue, dateFormat) => {
                 dateInstance = parseISO(dateValue);
             }
             if (!isValidDate(dateInstance)) {
-                // last chance: try to use the native Date.parse(), https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/parse
                 dateInstance = new Date(Date.parse(dateValue));
             }
         }

package/src/Utilities/Helpers/DisplayFormatHelper.js

@@ -1,4 +1,3 @@
-// TODO inspect why the following is erroring on angular build
 import { format as dateFnsFormat } from 'date-fns';
 import { sentenceCase } from '../Extensions/StringExtensions';
 import { DEFAULT_DATE_FORMAT_PATTERN } from '../Constants/GeneralConstants';
@@ -49,7 +48,6 @@ export function NumberFormatter(input, options = {}, rowNode, column, api) {
         multiplierFractionDigits = getFractionDigitsAfterMultiplier(preparedInput, options.Multiplier, options.FractionDigits);
         n = parseFloat(n.toFixed(multiplierFractionDigits));
     }
-    // Set Integer and Fraction Digits to a max of 20
     if (options.IntegerDigits > 20) {
         options.IntegerDigits = 20;
     }
@@ -98,9 +96,6 @@ export function NumberFormatter(input, options = {}, rowNode, column, api) {
         digitsToUse = decimalCount;
     }
     if (options.Notation === 'scientific') {
-        // Scientific notation: bypass locale grouping. Use toExponential
-        // for predictable mantissa-digit control and apply only the
-        // FractionSeparator post-hoc.
         s = n.toExponential(options.FractionDigits != null ? digitsToUse : undefined);
         if (options.FractionSeparator !== undefined && options.FractionSeparator !== '.') {
             s = s.replace('.', options.FractionSeparator);
@@ -116,12 +111,10 @@ export function NumberFormatter(input, options = {}, rowNode, column, api) {
             s = s.replace(/\./g, options.FractionSeparator);
         }
         if (options.IntegerSeparator !== undefined) {
-            // if fraction separator is not a comma then simply replace all instances
             if (options.FractionSeparator !== ',') {
                 s = s.replace(/\,/g, options.IntegerSeparator);
             }
             else {
-                // otherwise don't replace the last instance
                 s = StringExtensions.ReplaceAllOccurencesExceptLastOne(s, ',', options.IntegerSeparator);
             }
         }
@@ -138,7 +131,6 @@ export function DateFormatter(input, options, strictFormatting = false) {
     }
     try {
         if (typeof input === 'string') {
-            // Remove timezone info (e.g., Z or +02:00) using regex
             const cleanDateString = input.replace(/([+-]\d{2}:\d{2}|Z)$/, '');
             input = new Date(cleanDateString);
         }

package/src/Utilities/Helpers/Helper.js

@@ -11,7 +11,7 @@ export function objectHasKeys(item) {
 }
 export function getStringRepresentionFromKey(event) {
     if (event.key == null) {
-        return event.char; // IE
+        return event.char;
     }
     return event.key;
 }
@@ -28,7 +28,6 @@ export const arrayToKeyMap = (arr) => {
         return acc;
     }, defaultAccumulator);
 };
-// converts an array (or an array of arrays) to CSV
 export function convertArrayToCsv(array, separator = " ' ") {
     let csvContent = '';
     array.forEach((infoArray, index) => {
@@ -43,7 +42,6 @@ export function convertArrayToCsv(array, separator = " ' ") {
                         if (item.indexOf(',') !== -1 || item.indexOf('"') !== -1) {
                             item = `"${item.replace(/"/g, '""')}"`;
                         }
-                        // bit of a hack but we have a user where they have "+2502+S" as a value which Excel then thinks is a formula
                         if (item.indexOf('+') == 0) {
                             item = `'${item}'`;
                         }
@@ -65,7 +63,6 @@ export function createDownloadedFile(content, fileName, mimeType) {
     const a = document.createElement('a');
     mimeType = mimeType || 'application/octet-stream';
     if (URL && 'download' in a) {
-        // html5 A[download]
         a.href = URL.createObjectURL(new Blob([content], {
             type: mimeType,
         }));
@@ -79,7 +76,7 @@ export function createDownloadedFile(content, fileName, mimeType) {
         document.body.removeChild(a);
     }
     else {
-        location.href = `data:application/octet-stream,${encodeURIComponent(content)}`; // only this mime type is supported
+        location.href = `data:application/octet-stream,${encodeURIComponent(content)}`;
     }
 }
 export async function copyToClipboard(text) {
@@ -105,7 +102,7 @@ function copyToClipboardForOldBrowsers(text) {
         textarea.select();
         textarea.focus();
         try {
-            return document.execCommand('copy'); // Security exception may be thrown by some browsers.
+            return document.execCommand('copy');
         }
         catch (ex) {
             AdaptableLogger.consoleErrorBase('Copy to clipboard failed.', ex);
@@ -141,7 +138,6 @@ export function isInputNotNullOrEmpty(itemToCheck) {
     return !isInputNullOrEmpty(itemToCheck);
 }
 export function extractColsFromText(text) {
-    // rowData.columnName => columnName
     const regex = /\[rowData\.(.*?)\]/g;
     let m;
     const cols = [];
@@ -154,12 +150,10 @@ export function replaceAll(text, toReplace, replaceWith) {
     if (!text) {
         return text;
     }
-    // fails for []
     toReplace = toReplace.replace('[', '\\[').replace(']', '\\]');
     return text.replace(new RegExp(toReplace, 'g'), replaceWith);
 }
 export function extractContextKeysFromText(text) {
-    // context.columnName => columnName
     const regex = /\[context\.(.*?)\]/g;
     let m;
     const contextKeys = [];

package/src/Utilities/Helpers/PlusMinusHelper.js

@@ -1,15 +1,10 @@
 const DEFAULT_INCREMENT_KEY = '+';
 const DEFAULT_DECREMENT_KEY = '-';
-/**
- * Resolve increment/decrement trigger strings for a single nudge.
- * Per-nudge fields win; otherwise {@link PlusMinusOptions}; otherwise `+` / `-`.
- */
 export function resolvePlusMinusTriggerKeysForNudge(nudge, globalOptions) {
     const incrementKey = nudge.IncrementKey?.trim() || plusMinusIncrementKeyFromOptionsOnly(globalOptions);
     const decrementKey = nudge.DecrementKey?.trim() || plusMinusDecrementKeyFromOptionsOnly(globalOptions);
     return { incrementKey, decrementKey };
 }
-/** True when resolved increment and decrement would match the same key press. */
 export function plusMinusResolvedKeysConflict(nudge, globalOptions) {
     const { incrementKey, decrementKey } = resolvePlusMinusTriggerKeysForNudge(nudge, globalOptions);
     if (incrementKey === decrementKey) {
@@ -20,10 +15,6 @@ export function plusMinusResolvedKeysConflict(nudge, globalOptions) {
     }
     return false;
 }
-/**
- * Match a pressed key against a configured trigger. Single-character keys are
- * compared case-insensitively (aligned with Shortcut module behaviour).
- */
 export function plusMinusKeyMatches(actualKey, configuredKey) {
     if (!configuredKey) {
         return false;
@@ -36,18 +27,12 @@ export function plusMinusKeyMatches(actualKey, configuredKey) {
     }
     return false;
 }
-/** Increment key from `AdaptableOptions.plusMinusOptions` only, then built-in `+`. */
 export function plusMinusIncrementKeyFromOptionsOnly(globalOptions) {
     return globalOptions?.incrementKey?.trim() || DEFAULT_INCREMENT_KEY;
 }
-/** Decrement key from `AdaptableOptions.plusMinusOptions` only, then built-in `-`. */
 export function plusMinusDecrementKeyFromOptionsOnly(globalOptions) {
     return globalOptions?.decrementKey?.trim() || DEFAULT_DECREMENT_KEY;
 }
-/**
- * True when `candidate` is the same trigger as `baseline` for “no nudge override to persist”
- * (single-character keys compared case-insensitively, same as {@link plusMinusKeyMatches}).
- */
 export function plusMinusTriggerSameAsBaseline(candidate, baseline) {
     return plusMinusKeyMatches(candidate, baseline) && plusMinusKeyMatches(baseline, candidate);
 }
@@ -62,7 +47,6 @@ function addConfiguredKeyToLookup(lookup, configuredKey) {
         lookup.exactKeys.add(configuredKey);
     }
 }
-/** Build a lookup of all increment/decrement keys across active nudges (resolved). */
 export function buildPlusMinusTriggerKeyLookup(nudges, globalOptions) {
     const lookup = {
         singleCharLower: new Set(),
@@ -75,10 +59,6 @@ export function buildPlusMinusTriggerKeyLookup(nudges, globalOptions) {
     }
     return lookup;
 }
-/**
- * O(1) check: whether this pressed key could match any configured Plus Minus trigger.
- * When false, skip fetching cells / running nudge rules.
- */
 export function plusMinusKeyCouldTrigger(keyEventString, lookup) {
     if (!keyEventString) {
         return false;

package/src/Utilities/Helpers/QuickSearchHelper.js

@@ -11,7 +11,6 @@ const QUICK_SEARCH_FIND_CSS_KEYS = [
     'borderColor',
     'borderRadius',
 ];
-/** True when no style properties are set (including persisted `{}` placeholders). */
 export function isQuickSearchStyleUnset(style) {
     if (style == null) {
         return true;
@@ -38,28 +37,24 @@ export function isQuickSearchStyleUnset(style) {
         return true;
     });
 }
-/** Matching text highlight (AG Grid Find). Defaults at read time — not written to state unless set. */
 export function resolveQuickSearchTextMatchStyle(quickSearchState) {
     if (isQuickSearchStyleUnset(quickSearchState.TextMatchStyle)) {
         return QUICK_SEARCH_DEFAULT_TEXT_MATCH_STYLE;
     }
     return quickSearchState.TextMatchStyle;
 }
-/** Whole-cell background on matching cells. Undefined when unset (client-side). */
 export function resolveQuickSearchCellMatchStyle(quickSearchState) {
     if (isQuickSearchStyleUnset(quickSearchState.CellMatchStyle)) {
         return undefined;
     }
     return quickSearchState.CellMatchStyle;
 }
-/** Active match text highlight when cycling results. Defaults at read time. */
 export function resolveQuickSearchCurrentTextMatchStyle(quickSearchState) {
     if (isQuickSearchStyleUnset(quickSearchState.CurrentTextMatchStyle)) {
         return QUICK_SEARCH_DEFAULT_CURRENT_TEXT_MATCH_STYLE;
     }
     return quickSearchState.CurrentTextMatchStyle;
 }
-/** Apply Quick Search Find CSS variables on the grid container (`.ab-Grid`). */
 export function applyQuickSearchFindCssVars(container, quickSearchState) {
     if (!container) {
         return;

package/src/Utilities/Helpers/Scheduling/CronExpression.js

@@ -1,31 +1,8 @@
-/**
- * Lightweight, dependency-free parser for standard 5-field cron expressions:
- *
- *   minute  hour  day-of-month  month  day-of-week
- *
- * Each field supports:
- *   - `*` — every value in the field range
- *   - A single integer (e.g. `9`)
- *   - A comma-separated list (e.g. `1,3,5`)
- *   - A range (e.g. `1-5`)
- *   - A step (e.g. `* /15`, `0-30/5`)
- *
- * For day-of-week, both `0` and `7` represent Sunday.
- *
- * This module exists to keep AdapTable free of the `cron-parser` package (which
- * transitively pulls in `luxon`). AdapTable only uses cron expressions in the
- * Scheduling system, and only ever needs to:
- *   1. validate a user-entered cron string, and
- *   2. compute the next fire time from "now".
- */
 const MINUTE_RANGE = [0, 59];
 const HOUR_RANGE = [0, 23];
 const DAY_OF_MONTH_RANGE = [1, 31];
 const MONTH_RANGE = [1, 12];
 const FIELD_LABELS = ['minute', 'hour', 'day-of-month', 'month', 'day-of-week'];
-/**
- * Parses a 5-field cron expression. Throws when the expression is invalid.
- */
 export function parseCronExpression(expression) {
     if (!expression || typeof expression !== 'string') {
         throw new Error('Cron expression is empty');
@@ -49,9 +26,6 @@ export function parseCronExpression(expression) {
         dayOfWeekIsStar: parts[4] === '*',
     };
 }
-/**
- * Returns true if the given expression is a valid 5-field cron expression.
- */
 export function isCronExpressionValid(expression) {
     try {
         parseCronExpression(expression);
@@ -61,23 +35,15 @@ export function isCronExpressionValid(expression) {
         return false;
     }
 }
-/**
- * Returns the next time the cron expression fires after `fromDate` (exclusive).
- * Returns null if no match is found within a 4-year horizon.
- */
 export function getNextCronOccurrence(expression, fromDate = new Date()) {
     const cron = parseCronExpression(expression);
-    // Bump to the start of the next minute - cron has minute granularity and
-    // we never want to return `fromDate` itself.
     const next = new Date(fromDate.getTime());
     next.setSeconds(0, 0);
     next.setMinutes(next.getMinutes() + 1);
-    // Safety horizon — patterns like "0 0 31 2 *" (31 Feb) can never match.
     const horizon = new Date(next.getTime());
     horizon.setFullYear(horizon.getFullYear() + 4);
     while (next < horizon) {
         if (!cron.month.has(next.getMonth() + 1)) {
-            // Jump to the 1st of the next month.
             next.setDate(1);
             next.setHours(0, 0, 0, 0);
             next.setMonth(next.getMonth() + 1);
@@ -102,12 +68,6 @@ export function getNextCronOccurrence(expression, fromDate = new Date()) {
     }
     return null;
 }
-/**
- * Standard cron day matching:
- *   - if both day-of-month and day-of-week are `*`, the day always matches
- *   - if only one is `*`, only the other is applied
- *   - if neither is `*`, the day matches when **either** matches (OR semantics)
- */
 function matchesDay(cron, date) {
     const domMatches = cron.dayOfMonth.has(date.getDate());
     const dowMatches = cron.dayOfWeek.has(date.getDay());
@@ -167,9 +127,6 @@ function parseField(field, range, label) {
     return values;
 }
 function parseDayOfWeekField(field) {
-    // Cron allows 0 or 7 to represent Sunday — parse with an extended range
-    // [0,7] and then collapse 7 → 0 so callers can compare against
-    // `Date.getDay()` which returns 0-6.
     const extended = parseField(field, [0, 7], 'day-of-week');
     const normalised = new Set();
     for (const value of extended) {

package/src/Utilities/Helpers/Scheduling/ScheduledReportHelper.js

@@ -21,10 +21,6 @@ function ensureScheduleUuid(schedule) {
 export function exportStateNeedsScheduleUuids(exportState) {
     return (exportState.ReportSchedules ?? []).some((schedule) => !schedule.Uuid);
 }
-/**
- * Assigns a unique {@link ReportSchedule.Uuid} to any schedule that lacks one.
- * Required so edit/suspend/delete match a single schedule (not every `undefined` uuid).
- */
 export function ensureExportStateSchedulesUuids(exportState) {
     if (!exportStateNeedsScheduleUuids(exportState)) {
         return exportState;

package/src/Utilities/Helpers/SettingsPanelHelper.js

@@ -24,7 +24,7 @@ export const DEFAULT_SETTINGS_PANEL_NAVIGATION_GROUPS = [
         items: ['Export', 'DataImport'],
     },
     {
-        label: 'ֵEditing',
+        label: 'Editing',
         items: ['PlusMinus', 'Shortcut', 'DataChangeHistory'],
     },
     {
@@ -51,11 +51,47 @@ const cloneSettingsPanelNavigation = (navigation) => ({
         items: [...group.items],
     })),
 });
+const convertLegacyFlatNavigationToGrouped = (legacy) => {
+    const items = legacy.items ?? [];
+    const groups = [];
+    let current = [];
+    for (const item of items) {
+        if (item === '-') {
+            if (current.length) {
+                groups.push({ label: '', items: current });
+                current = [];
+            }
+        }
+        else {
+            current.push(item);
+        }
+    }
+    if (current.length) {
+        groups.push({ label: '', items: current });
+    }
+    return { groups };
+};
+let didWarnLegacyNavigation = false;
+const warnLegacyNavigationOnce = (api) => {
+    if (didWarnLegacyNavigation) {
+        return;
+    }
+    didWarnLegacyNavigation = true;
+    api.internalApi
+        .getAdaptableInstance()
+        .logger.consoleWarn("SettingsPanelOptions.navigation is using the legacy v22 `{ items: [...] }` shape — this is deprecated and will be removed in the next major release. Use a SettingsPanelNavigationConfigurer function: `(context, defaultNavigation) => SettingsPanelNavigation`.");
+};
+const isNavigationConfigurer = (navigation) => typeof navigation === 'function';
 export const resolveSettingsPanelNavigation = (api, settingsPanelOptions) => {
     const defaultNavigation = buildDefaultSettingsPanelNavigation(settingsPanelOptions.customSettingsPanels?.map((panel) => panel.name) ?? []);
-    if (!settingsPanelOptions.navigation) {
+    const navigation = settingsPanelOptions.navigation;
+    if (!navigation) {
         return defaultNavigation;
     }
-    const context = api.internalApi.buildBaseContext();
-    return settingsPanelOptions.navigation(context, cloneSettingsPanelNavigation(defaultNavigation));
+    if (isNavigationConfigurer(navigation)) {
+        const context = api.internalApi.buildBaseContext();
+        return navigation(context, cloneSettingsPanelNavigation(defaultNavigation));
+    }
+    warnLegacyNavigationOnce(api);
+    return convertLegacyFlatNavigationToGrouped(navigation);
 };