@adaptabletools/adaptable 23.0.4 → 23.0.5-canary.1

package/src/View/StyledColumn/Wizard/StyledColumnWizardStyleSection/StyledColumnWizardRangesSection.js

@@ -9,13 +9,6 @@ import { Box } from '../../../../components/Flex';
 import { PercentBarColumnComparisonPreview } from './Components/PercentBarColumnComparisonPreview';
 import { PercentBarPreview } from './Components/PercentBarRangesPreview';
 import { GradientColumnComparisonSummaryPreview, GradientRangesSummaryPreview, } from './Components/GradientSummaryPreview';
-// ---------------------------------------------------------------------------
-// Summary helpers (extracted from the old single-step Style section)
-// ---------------------------------------------------------------------------
-/**
- * Summary of the Ranges / Column Comparison configuration of a styled column.
- * Works for both Gradient and Percent Bar.
- */
 export const renderStyledColumnRangesSummary = (data, api) => {
     if (!api) {
         const { api: adaptableApi } = useOnePageAdaptableWizardContext();
@@ -62,7 +55,6 @@ export const StyledColumnWizardRangesSection = (props) => {
     }, [column, api]);
     const scope = { ColumnIds: [data.ColumnId] };
     const disabled = !data.ColumnId || !column;
-    // Gradient updates
     const onUpdateGradientStyleRanges = (ranges) => {
         const gradientStyle = {
             ...data.GradientStyle,
@@ -86,17 +78,12 @@ export const StyledColumnWizardRangesSection = (props) => {
         const gradientStyle = {
             ...data.GradientStyle,
             ZeroCentred: zc,
-            // Zero-centred bands use absolute numeric 0 as the midpoint; Percentage
-            // mode interprets numeric endpoints as % along Col-Min…Col-Max and breaks
-            // the diverging bands (see `gradientStyleRangeLookupValueType`).
             RangeValueType: 'Number',
         };
         delete gradientStyle.CellRanges;
         delete gradientStyle.ColumnComparison;
         props.onChange({ ...data, GradientStyle: gradientStyle });
     };
-    // Percent Bar updates — switching to Column Comparison wipes any existing
-    // CellRanges / RangeValueType so the two modes can't coexist in state.
     const onUpdatePercentBarStyleColumnComparison = (columnComparison) => {
         const nextPercentBar = {
             ...data.PercentBarStyle,

package/src/View/StyledColumn/Wizard/StyledColumnWizardStyleSection/StyledColumnWizardStyleSection.js

@@ -13,11 +13,7 @@ import Radio, { RadioGroup } from '../../../../components/Radio';
 import { getCellFontStyleSummaryItems, StyledColumnFontStyleEditor, } from '../StyledColumnSliceStyleEditors';
 import { Card } from '../../../../components/Card';
 import { renderSummaryStringTags } from '../../../Wizard/SummaryColorTag';
-// Re-export the Ranges section + summary for legacy import paths.
 export { renderStyledColumnRangesSummary, StyledColumnWizardRangesSection, } from './StyledColumnWizardRangesSection';
-// ---------------------------------------------------------------------------
-// Summary helpers
-// ---------------------------------------------------------------------------
 const formatOriginLabel = (origin) => {
     if (origin == undefined) {
         return 'Auto';
@@ -66,9 +62,6 @@ export const getStyledColumnPercentBarStyleViewValues = (data) => {
         includeEmptyTooltip: false,
     });
 };
-/**
- * Compact summary of the *non-range* style properties of a Percent Bar.
- */
 export const renderStyledColumnStyleSummary = (data, _api) => {
     const pb = data.PercentBarStyle;
     if (!pb) {
@@ -80,13 +73,9 @@ export const renderStyledColumnStyleSummary = (data, _api) => {
     });
     return renderSummaryStringTags(items);
 };
-// Legacy wrapper kept for any external consumers; safe no-op here.
 export const renderFormatColumnStyleWizardSummary = (data) => {
     return renderStyledColumnStyleSummary(data);
 };
-// Shared label-column width across all FormLayout blocks in this section.
-// Pinning the width forces colons to line up vertically across cards rather than
-// each FormLayout sizing its label column independently from its own longest label.
 const STYLE_FORM_SIZES = ['200px', '1fr'];
 const ORIGIN_CHOICES = [
     {
@@ -113,7 +102,6 @@ export const StyledColumnWizardStyleSection = (props) => {
     }
     const pb = data.PercentBarStyle;
     const cellTextProperties = pb.CellTextProperties;
-    // ---- updaters -----------------------------------------------------------
     const update = (patch) => {
         props.onChange({
             ...data,
@@ -146,7 +134,7 @@ export const StyledColumnWizardStyleSection = (props) => {
     };
     const cellTextDisabled = !hasBarStyleCellTextConfigured(cellTextProperties) || disabled;
     const currentOrigin = typeof pb.Origin === 'number'
-        ? 'Min' // numeric origin doesn't fit the radio set; treat as Min for selection state
+        ? 'Min'
         : pb.Origin ?? 'Auto';
     return (_jsxs(Box, { children: [_jsxs(Card, { shadow: false, className: "twa:mb-3", children: [_jsxs(Card.Title, { children: [_jsx(Box, { className: "twa:font-medium", children: "Bar Position" }), _jsx(Box, { className: "twa:text-xs twa:opacity-70 twa:font-normal twa:max-w-[520px]", children: "Set the position of the cell text relative to the bar" })] }), _jsx(Card.Body, { children: _jsx(RadioGroup, { orientation: "vertical", name: "ab-percentbar-origin", value: currentOrigin, onRadioChange: handleOriginChange, children: ORIGIN_CHOICES.map((choice) => (_jsx(Radio, { value: choice.value, disabled: disabled, children: _jsxs(Flex, { alignItems: "center", children: [_jsx(Box, { className: "twa:min-w-[60px]", children: choice.label }), _jsx(Box, { className: "twa:text-xs twa:opacity-70", children: choice.hint })] }) }, choice.value))) }) })] }), _jsxs(Card, { shadow: false, className: "twa:mb-3", children: [_jsxs(Card.Title, { children: [_jsx(Box, { className: "twa:font-medium", children: "Cell Text" }), _jsx(Box, { className: "twa:text-xs twa:opacity-70 twa:font-normal twa:max-w-[540px]", children: "Pick which values to display and where each one sits around the bar (font properties take precedence over Format Column)" })] }), _jsxs(Card.Body, { children: [_jsx(FormLayout, { sizes: [...STYLE_FORM_SIZES], children: _jsx(BarStyleCellTextLayoutEditor, { disabled: disabled, cellTextProperties: cellTextProperties, onToggle: onCellTextLayoutToggle, onPlacementChange: onCellTextPlacementChange }) }), _jsx(Box, { className: `twa:mt-3 twa:pt-3 twa:border-t twa:border-foreground/15 ${cellTextDisabled ? 'twa:opacity-50' : ''}`, children: _jsx(StyledColumnFontStyleEditor, { api: api, disabled: cellTextDisabled, value: pb.Font, onChange: (next) => {
                                         if (next) {

package/src/View/StyledColumn/Wizard/StyledColumnWizardTypeSection.js

@@ -98,12 +98,6 @@ const STYLED_COLUMN_TYPE_OPTION_BY_KEY = STYLED_COLUMN_TYPE_OPTIONS.reduce((map,
     return map;
 }, new Map());
 const STYLED_COLUMN_TYPE_KEYS = STYLED_COLUMN_TYPE_GROUPS.flatMap((group) => group.types);
-/**
- * Wizard-header title for each Styled Column type. Reads as a complete
- * subject so it works as a top-level title in the wizard frame
- * ("Gradient Column" rather than just "Gradient"). Falls back to
- * "Styled Column" before a type has been chosen.
- */
 const TYPE_WIZARD_TITLES = {
     Gradient: 'Gradient Column',
     PercentBar: 'Percent Bar Column',
@@ -114,10 +108,6 @@ const TYPE_WIZARD_TITLES = {
     RangeBar: 'Range Bar Column',
     Icon: 'Icon Column',
 };
-/**
- * Resolves the Styled Column type from the discriminator properties. Used by
- * the Settings-step summary to show a human-readable type tag.
- */
 const getTypeLabel = (data) => {
     if (data.GradientStyle)
         return 'Gradient';
@@ -137,12 +127,6 @@ const getTypeLabel = (data) => {
         return 'Icon';
     return null;
 };
-/**
- * The title displayed in the wizard header. Switches from "Styled
- * Column" to the specific type ("Gradient Column", "Percent Bar
- * Column", …) once a type has been picked, so the user always knows
- * which kind of column they're configuring.
- */
 export const getStyledColumnWizardTitle = (data) => {
     const typeKey = getTypeLabel(data);
     return typeKey ? TYPE_WIZARD_TITLES[typeKey] : 'Styled Column';
@@ -151,11 +135,6 @@ export const renderStyledColumnSettingsSummary = (data) => {
     const typeKey = getTypeLabel(data);
     return (_jsxs(Box, { className: "twa:pr-2 twa:py-2", children: [_jsxs(Box, { className: "twa:mt-1", children: ["Name ", _jsx(Tag, { children: data.Name || '(none)' })] }), _jsxs(Box, { className: "twa:mt-2", children: ["Type ", _jsx(Tag, { children: typeKey ? TYPE_LABELS[typeKey] : '(none)' })] })] }));
 };
-/**
- * Backwards-compatible export: the wizard previously imported
- * `renderStyledColumnTypeSummary`. The settings step now also covers Name,
- * but to keep external imports happy we re-export under the old alias.
- */
 export const renderStyledColumnTypeSummary = renderStyledColumnSettingsSummary;
 export const StyledColumnWizardTypeSection = (props) => {
     const { data } = useOnePageAdaptableWizardContext();

package/src/View/SystemStatus/SystemStatusPopup.js

@@ -17,7 +17,6 @@ const colItems = [
 class SystemStatusPopupComponent extends React.Component {
     constructor(props) {
         super(props);
-        // this.state = { EditedSystemStatusText: '', EditedStyle: null };
     }
     onSystemStatusMessageInfoDeleteAll() {
         this.props.onSystemStatusMessageInfoDeleteAll();

package/src/View/TeamSharing/SharedEntityObjectView.js

@@ -45,7 +45,6 @@ export const getSharedEntityActiveStatusObjectView = (isDependency) => (props) =
                         `Imported Rev. ${activeRevision} ${isStaleAndActive ? 'is stale' : ''} `, ' ', statusInfo] }));
         }
         else {
-            // snapshot
             activeInfo = activeRevision && _jsx(_Fragment, { children: `Imported Rev. ${activeRevision}` });
         }
     }

package/src/View/Theme/ThemeSelector.js

@@ -14,7 +14,6 @@ export const ThemeSelector = (props) => {
         ACCESS_LEVEL_READ_ONLY;
     const optionThemes = availableThemes.map((theme) => {
         if (typeof theme === 'string') {
-            // protection against old state, which could be string
             theme = {
                 Name: theme,
                 Description: theme,

package/src/View/UIHelper.js

@@ -4,18 +4,15 @@ import { StringExtensions } from '../Utilities/Extensions/StringExtensions';
 import { getScheduleDescription as getScheduleDescriptionFromHelper } from '../Utilities/Helpers/Scheduling/ScheduleHelper';
 import ArrayExtensions from '../Utilities/Extensions/ArrayExtensions';
 import { resolveContainerElement } from '../Utilities/resolveContainerElement';
-/** Generic swatch entries for the Colour Picker (resolved at runtime per active theme). */
 export function getSwatchColorVar(index) {
     return `var(--ab-color-swatch-${index})`;
 }
-/** Default mid-gray from the theme swatch palette (`--ab-color-swatch-4`). */
 export function getGraySwatchColor() {
     return getSwatchColorVar(4);
 }
 export function getSwatchColorPaletteEntries() {
     return Array.from({ length: 20 }, (_, i) => getSwatchColorVar(i + 1));
 }
-/** Theme semantic colours for the Colour Picker (resolved at runtime per active theme). */
 export function getThemeSemanticColorPaletteEntries() {
     return [
         'var(--ab-color-destructive)',
@@ -37,7 +34,6 @@ export function getThemeSemanticColorPaletteEntries() {
         'var(--ab-color-palette-12)',
     ];
 }
-/** Swatch and theme semantic entries (default Colour Picker set). */
 export function getDefaultColorPalette() {
     return [...getSwatchColorPaletteEntries(), ...getThemeSemanticColorPaletteEntries()];
 }
@@ -328,14 +324,12 @@ export function getSimpleButtonPaddingWidth() {
 }
 export function getCSSVariableValue(cssVariable) {
     if (!isBrowserDocumentAvailable()) {
-        // possible during static/server-side rendering (should happen only in test cases)
         return undefined;
     }
     return getComputedStyle(document.documentElement).getPropertyValue(cssVariable);
 }
 export function setCSSVariableValue(cssVariable, value) {
     if (!isBrowserDocumentAvailable()) {
-        // possible during static/server-side rendering (should happen only in test cases)
         return undefined;
     }
     document.documentElement.style.setProperty(cssVariable, value);

package/src/View/UIInterfaces.js

@@ -1,2 +1 @@
-// NOTE:  this file will include only those interfaces that are used in the UI / views,
 export {};

package/src/View/Wizard/CollapsibleWizardCard.js

@@ -40,13 +40,7 @@ export const CollapsibleWizardCard = (props) => {
             ? getCollapsibleWizardCardExpandedClasses(surface)
             : getCollapsibleWizardCardCollapsedClasses(surface), compact && 'ab-CollapsibleWizardCard--compact twa:p-0!', fillAvailable
             ? 'twa:flex-1 twa:min-h-0 twa:flex twa:flex-col twa:overflow-hidden'
-            : 'twa:shrink-0', className), children: [_jsx(Card.Title, { className: "twa:p-0", border: !compact, children: _jsxs(Box, { className: cn('twa:flex twa:flex-row twa:items-center twa:gap-2 twa:w-full twa:px-2 twa:cursor-pointer twa:rounded-standard twa:hover:bg-primary', { 'twa:py-2': true, 'twa:mb-0.5': !compact && !expanded }, 
-                    // `targetOwn.focusOutline` uses a Tailwind `ring` (an *outward* box-shadow).
-                    // In compact/collapsed mode the card sets `p-0!`, so this header sits flush
-                    // against the card edge; combined with the card's `overflow-hidden` the
-                    // outward ring is painted outside the border-box and clipped away. Draw it
-                    // inset so it stays inside the element and is always visible.
-                    targetOwn.focusOutline, 'twa:focus-visible:ring-inset'), "data-name": dataName, onClick: toggleExpanded, onKeyDown: handleTitleKeyDown, tabIndex: 0, "aria-expanded": expanded, role: "button", children: [_jsxs(Box, { className: "twa:flex twa:flex-row twa:items-center twa:gap-2 twa:shrink-0 twa:cursor-pointer twa:select-none", children: [_jsx(IconComponent, { icon: { name: expanded ? 'collapse' : 'expand' } }), _jsx(Box, { className: "twa:font-medium", children: title })] }), headerVisual ? (_jsx(Box, { className: "twa:flex-1 twa:min-w-0 twa:flex twa:justify-end twa:items-center twa:overflow-hidden twa:pointer-events-none", children: headerVisual })) : headerInline ? (_jsx(Box, { className: cn('twa:flex-1 twa:min-w-0 twa:font-normal', isInteractiveCompactSummary
+            : 'twa:shrink-0', className), children: [_jsx(Card.Title, { className: "twa:p-0", border: !compact, children: _jsxs(Box, { className: cn('twa:flex twa:flex-row twa:items-center twa:gap-2 twa:w-full twa:px-2 twa:cursor-pointer twa:rounded-standard twa:hover:bg-primary', { 'twa:py-2': true, 'twa:mb-0.5': !compact && !expanded }, targetOwn.focusOutline, 'twa:focus-visible:ring-inset'), "data-name": dataName, onClick: toggleExpanded, onKeyDown: handleTitleKeyDown, tabIndex: 0, "aria-expanded": expanded, role: "button", children: [_jsxs(Box, { className: "twa:flex twa:flex-row twa:items-center twa:gap-2 twa:shrink-0 twa:cursor-pointer twa:select-none", children: [_jsx(IconComponent, { icon: { name: expanded ? 'collapse' : 'expand' } }), _jsx(Box, { className: "twa:font-medium", children: title })] }), headerVisual ? (_jsx(Box, { className: "twa:flex-1 twa:min-w-0 twa:flex twa:justify-end twa:items-center twa:overflow-hidden twa:pointer-events-none", children: headerVisual })) : headerInline ? (_jsx(Box, { className: cn('twa:flex-1 twa:min-w-0 twa:font-normal', isInteractiveCompactSummary
                                 ? 'twa:flex twa:justify-end twa:items-center twa:overflow-visible'
                                 : cn('twa:text-xs twa:opacity-70 twa:pointer-events-none twa:cursor-default', compact ? 'twa:overflow-hidden' : 'twa:truncate')), children: headerInline })) : (_jsx(Box, { className: "twa:flex-1 twa:min-w-0" })), headerActions ? (_jsx(Box, { className: "twa:shrink-0 twa:gap-2 twa:flex", onClick: (event) => event.stopPropagation(), children: headerActions })) : null] }) }), expanded ? (_jsx(Card.Body, { className: cn('twa:p-1', bodyClassName, fillAvailable && 'twa:max-h-none! twa:flex-1 twa:min-h-0'), children: children })) : showSummary ? (_jsx(Card.Body, { className: "twa:p-1", gap: 1, children: summary })) : null] }));
 };
@@ -77,5 +71,4 @@ export function useWizardCardAccordion(initialExpandedId, options) {
         setExpandedId,
     };
 }
-/** Collapsed card body: selected value tag(s) only — no description text. */
 export const CollapsibleWizardValueSummary = ({ value }) => _jsx(_Fragment, { children: value });

package/src/View/Wizard/OnePageWizards.js

@@ -15,7 +15,6 @@ import { useKeyboardNavigation } from './useKeyboardNavigation';
 import { Box, Flex } from '../../components/Flex';
 import { twMerge } from '../../twMerge';
 import { targetOwn } from '../../components/twUtils';
-/** Same template for header row and main row so module/details align with nav / content columns. */
 const ONE_PAGE_WIZARD_SECTION_GRID = 'twa:grid twa:grid-cols-[minmax(160px,14rem)_minmax(0,1fr)]';
 export const SummaryTag = (props) => (_jsx(Box, { ...props }));
 export const SummaryText = (props) => (_jsx(Box, { ...props, className: twMerge('twa:text-2 twa:mb-3', props.className) }));
@@ -48,12 +47,6 @@ export const OnePageWizard = (props) => {
             section.isVisible(props.data, contextValue));
     }, [props.sections]);
     contextValue.sections = visibleSections;
-    // Apply `defaultCurrentSectionName` only once per distinct value. Without
-    // this guard the effect re-fires every render (because `visibleSections` is
-    // recomputed each render whenever the parent rebuilds `sections`), which
-    // makes the wizard snap back to the default section on every interior
-    // state change — e.g. clicking a checkbox in an *earlier* step would yank
-    // the user forward to the default step again.
     const lastAppliedDefaultSectionName = React.useRef(undefined);
     React.useEffect(() => {
         if (!props.defaultCurrentSectionName) {
@@ -107,7 +100,7 @@ export const OnePageWizard = (props) => {
             acc.set(index, true);
             return acc;
         }
-        const valid = section.isValid ? section.isValid(props.data, contextValue) : true; //!active && canFinish !== true;
+        const valid = section.isValid ? section.isValid(props.data, contextValue) : true;
         if (valid !== true) {
             invalidCount++;
             if (firstErrorMessage == null) {
@@ -143,7 +136,7 @@ export const OnePageWizard = (props) => {
                                             navIndex++;
                                             navIndexMap.set(navIndex, index);
                                             const active = index === currentSection;
-                                            const disabled = false; //!active && !currentSectionValid;
+                                            const disabled = false;
                                             return (_jsxs(Flex, { className: cn('ab-OnePageWizard__section-title twa:p-2', {
                                                     'twa:cursor-auto': disabled,
                                                     'twa:cursor-pointer': !disabled,

package/src/View/Wizard/SummaryColorTag.js

@@ -7,7 +7,6 @@ import { AdaptableIconComponent } from '../Components/AdaptableIconComponent';
 const COLOR_SQUARE_CLASS = 'twa:h-3 twa:w-3 twa:rounded-sm twa:shrink-0 twa:border twa:border-[color-mix(in_srgb,var(--ab-color-foreground)_20%,transparent)]';
 export const isSummaryColorLabel = (label) => /\bColou?r$/i.test(label.trim());
 const isIconSummaryLabel = (label) => label.trim() === 'Icon';
-/** Labels whose label + value render together inside a single tag (colours, font traits). */
 export const isSummaryInTagLabel = (label) => {
     const trimmed = label.trim();
     return (isSummaryColorLabel(trimmed) ||

package/src/View/Wizard/useKeyboardNavigation.js

@@ -1,9 +1,7 @@
 import * as React from 'react';
 export const useKeyboardNavigation = (setCurrentSection, sections) => {
     const handleKeyPress = React.useCallback((event) => {
-        if (
-        // (event.ctrlKey || event.metaKey) &&
-        event.code === 'ArrowUp' ||
+        if (event.code === 'ArrowUp' ||
             event.code === 'ArrowDown') {
             event.preventDefault();
             event.stopPropagation();

package/src/agGrid/Adaptable.js

@@ -7,13 +7,6 @@ import { renderReactRoot as defaultRenderReactRoot } from '../renderReactRoot';
 import AdaptableWizardView from '../View/AdaptableWizardView';
 import { resolveContainerElement } from '../Utilities/resolveContainerElement';
 export class Adaptable {
-    /**
-     * Initializer for Adaptable
-     *
-     * @param adaptableOptions the AdaptableOptions
-     * @param agGridConfig AG Grid
-     * @returns a Promise containing the AdaptableAPI object in order to enable run-time access to Adaptable's properties and functions
-     */
     static init(adaptableOptions, agGridConfig) {
         if (!agGridConfig?.modules?.length) {
             AdaptableLogger.consoleErrorBase(`No AG Grid modules were provided, thus limiting AdapTables features significantly!\n\nRead further info here:${AgGridModulesDocsLink}`);
@@ -26,9 +19,6 @@ export class AdaptableNoCodeWizard {
     adaptableOptions;
     extraOptions;
     agGridModules;
-    /**
-     * @param adaptableOptions
-     */
     constructor(adaptableOptions, extraOptions = {}, agGridOptions) {
         const defaultInit = async ({ gridOptions, adaptableOptions, agGridModules, }) => {
             return await Adaptable.init(adaptableOptions, { gridOptions, modules: agGridModules });
@@ -55,8 +45,6 @@ export class AdaptableNoCodeWizard {
         if (!container) {
             throw new Error('Cannot find container in which to render Adaptable No Code Wizard');
         }
-        // this allows people to customize the wizard dimensions & styling
-        // when it's visible
         container.classList.add('adaptable--in-wizard');
         const unmount = defaultRenderReactRoot(React.createElement(AdaptableWizardView, {
             adaptableOptions: this.adaptableOptions,

package/src/agGrid/AdaptableAgGrid.d.ts

@@ -15,7 +15,6 @@ import { IValidationService } from '../Utilities/Services/Interface/IValidationS
 import { IQueryLanguageService } from '../Utilities/Services/Interface/IQueryLanguageService';
 import { IAlertService } from '../Utilities/Services/Interface/IAlertService';
 import { ITeamSharingService } from '../Utilities/Services/Interface/ITeamSharingService';
-import { IMetamodelService } from '../Utilities/Services/Interface/IMetamodelService';
 import { IThemeService } from '../Utilities/Services/Interface/IThemeService';
 import { Fdc3Service } from '../Utilities/Services/Fdc3Service';
 import { AnnotationsService } from '../Utilities/Services/AnnotationsService';
@@ -88,7 +87,6 @@ export declare class AdaptableAgGrid implements IAdaptable {
     QueryLanguageService: IQueryLanguageService;
     AlertService: IAlertService;
     TeamSharingService: ITeamSharingService;
-    MetamodelService: IMetamodelService;
     RowFormService: RowFormService;
     Fdc3Service: Fdc3Service;
     AnnotationsService: AnnotationsService;