@adaptabletools/adaptable 23.0.0-canary.7 → 23.0.0-canary.8

package/src/migration/VersionUpgrade23.d.ts

@@ -1,39 +1,21 @@
 import { VersionUpgrade } from './VersionUpgrade';
 import { AdaptableState } from '../AdaptableState/AdaptableState';
-/**
- * Version 23 — all state changes since the last major release:
- *
- * Styled columns:
- * - Gradient zero-centred layout + Styled Column Name + Badge pill
- * style + Styled Column `RowScope`.
- *
- * - Replaces the legacy two-`CellRanges` diverging pattern (`Col-Min`…`0` with
- *   `ReverseGradient: true` + `0`…`Col-Max`) with an explicit
- *   `GradientStyle.ZeroCentred` object `{ NegativeColor, PositiveColor }`.
- * - Backfills the new mandatory `Name` property on every `StyledColumn` using a
- *   deterministic `${Type}-${ColumnId}` default (e.g. `Badge-tradeId`,
- *   `Gradient-notional`).
- * - Migrates `BadgeStyleDefinition.Style` (full `AdaptableStyle`) to
- *   `PillStyle`, infers `Shape` from legacy `BorderRadius` when needed, and lifts
- *   per-pill `Alignment` to `BadgeStyle.Font.Alignment` when present.
- * - Promotes `BadgeStyle.RowScope` to the top-level `StyledColumn.RowScope`
- *   so the same row-kind selection applies to every Styled Column type, not
- *   just Badge.
- *
- * Note: `ReverseGradient` on `CellColorRange` is **still supported** (lower-is-darker
- * per-range option). This migration only collapses the *full* legacy diverging
- * shape into `ZeroCentred`; standalone `ReverseGradient` ranges are left untouched.
- *
- * Scheduling:
- * - Remove the legacy Schedule state section entirely (Reminders, ReportSchedules,
- *   IPushPull, OpenFin, and any other keys). Schedules now live under Export / Alert.
- *
- * On first load after upgrade, `AdaptableUpgradeHelper.migrateAdaptableState` runs this when
- * `autoMigrateState` is enabled.
- */
 export declare class VersionUpgrade23 extends VersionUpgrade {
     migrateState(state: AdaptableState): AdaptableState;
     private migrateSchedulingState;
+    /**
+     * v22 Percent Bar stored cell-text overlay settings as flat
+     * `CellText: CellTextOptions` + `CellTextPosition: 'Above' | 'Below' | 'Merged'`
+     * keys on `PercentBarStyle`. v23 replaces them with the per-value
+     * `CellTextProperties.CellTextLayout: { CellValue?, PercentValue? }`, where
+     * each value carries its own `Horizontal` and `Vertical` placement.
+     *
+     * The flat keys are forwarded onto the new layout (`Horizontal: 'Left'`,
+     * `Vertical` taken from `CellTextPosition`) and stripped from the parent
+     * style. Range Bar and Bullet Chart never shipped cell-text overlays in
+     * v22 so they need no migration here.
+     */
+    private migratePercentBarCellText;
     /**
      * `RowScope` (which row kinds — data / group / summary / total — render
      * the style) was originally a Badge-only concept. It applies equally to
@@ -46,6 +28,20 @@ export declare class VersionUpgrade23 extends VersionUpgrade {
      * Then delete the nested copy so we only have one source of truth going
      * forward.
      */
+    /**
+     * v22 Badge icon settings lived as four flat keys on
+     * `BadgeStyleDefinition`: `Icon`, `IconPosition`, `IconOnly` (and the
+     * v23 canary-only `IconGap`). v23 groups them under
+     * `IconProperties: { Icon, Position, Gap, IconOnly }`.
+     *
+     * Migration: per badge, if any of the flat keys are present, build
+     * `IconProperties` (renaming `IconPosition → Position` and `IconGap → Gap`,
+     * leaving `IconOnly` as-is) and strip the flat keys from the parent.
+     * `IconProperties.Icon` is required, so if the only flat fields set were
+     * decoration flags (`IconPosition` / `IconOnly` / `IconGap`) without an
+     * `Icon`, those flags are dropped (they had no effect anyway).
+     */
+    private migrateBadgeIconProperties;
     private liftBadgeStyleRowScope;
     /**
      * `Name` was added as a mandatory property on `StyledColumn` (mirroring every

package/src/migration/VersionUpgrade23.js

@@ -1,39 +1,32 @@
 import { VersionUpgrade } from './VersionUpgrade';
+import { mergeBarChartCellTextProperties } from '../Utilities/Helpers/barChartCellText';
 /**
- * Version 23 — all state changes since the last major release:
- *
- * Styled columns:
- * - Gradient zero-centred layout + Styled Column Name + Badge pill
- * style + Styled Column `RowScope`.
- *
- * - Replaces the legacy two-`CellRanges` diverging pattern (`Col-Min`…`0` with
- *   `ReverseGradient: true` + `0`…`Col-Max`) with an explicit
- *   `GradientStyle.ZeroCentred` object `{ NegativeColor, PositiveColor }`.
- * - Backfills the new mandatory `Name` property on every `StyledColumn` using a
- *   deterministic `${Type}-${ColumnId}` default (e.g. `Badge-tradeId`,
- *   `Gradient-notional`).
- * - Migrates `BadgeStyleDefinition.Style` (full `AdaptableStyle`) to
- *   `PillStyle`, infers `Shape` from legacy `BorderRadius` when needed, and lifts
- *   per-pill `Alignment` to `BadgeStyle.Font.Alignment` when present.
- * - Promotes `BadgeStyle.RowScope` to the top-level `StyledColumn.RowScope`
- *   so the same row-kind selection applies to every Styled Column type, not
- *   just Badge.
- *
- * Note: `ReverseGradient` on `CellColorRange` is **still supported** (lower-is-darker
- * per-range option). This migration only collapses the *full* legacy diverging
- * shape into `ZeroCentred`; standalone `ReverseGradient` ranges are left untouched.
- *
- * Scheduling:
- * - Remove the legacy Schedule state section entirely (Reminders, ReportSchedules,
- *   IPushPull, OpenFin, and any other keys). Schedules now live under Export / Alert.
- *
- * On first load after upgrade, `AdaptableUpgradeHelper.migrateAdaptableState` runs this when
- * `autoMigrateState` is enabled.
+ * Forward v22 `{ CellText, CellTextPosition }` into the canonical per-value
+ * layout. Each token in `CellText` becomes one placement on the
+ * `CellTextLayout` with `Horizontal: 'Left'` and `Vertical = CellTextPosition`.
+ * Returns `undefined` when no v22 cell-text was configured.
  */
+const migrateLegacyPercentBarCellText = (legacy) => {
+    const tokens = legacy.CellText ?? [];
+    if (!tokens.length) {
+        return undefined;
+    }
+    const vertical = legacy.CellTextPosition ?? 'Below';
+    const layout = {};
+    if (tokens.includes('CellValue')) {
+        layout.CellValue = { Horizontal: 'Left', Vertical: vertical };
+    }
+    if (tokens.includes('PercentageValue')) {
+        layout.PercentValue = { Horizontal: 'Left', Vertical: vertical };
+    }
+    return mergeBarChartCellTextProperties(undefined, { CellTextLayout: layout });
+};
 export class VersionUpgrade23 extends VersionUpgrade {
     migrateState(state) {
         this.migrateStyledColumnGradientZeroCentred(state);
         this.migrateBadgeStyleToPillStyle(state);
+        this.migrateBadgeIconProperties(state);
+        this.migratePercentBarCellText(state);
         this.patchStyledColumnName(state);
         this.liftBadgeStyleRowScope(state);
         return this.migrateSchedulingState(state);
@@ -59,6 +52,41 @@ export class VersionUpgrade23 extends VersionUpgrade {
         const { Schedule: _removed, ...stateWithoutSchedule } = state;
         return stateWithoutSchedule;
     }
+    /**
+     * v22 Percent Bar stored cell-text overlay settings as flat
+     * `CellText: CellTextOptions` + `CellTextPosition: 'Above' | 'Below' | 'Merged'`
+     * keys on `PercentBarStyle`. v23 replaces them with the per-value
+     * `CellTextProperties.CellTextLayout: { CellValue?, PercentValue? }`, where
+     * each value carries its own `Horizontal` and `Vertical` placement.
+     *
+     * The flat keys are forwarded onto the new layout (`Horizontal: 'Left'`,
+     * `Vertical` taken from `CellTextPosition`) and stripped from the parent
+     * style. Range Bar and Bullet Chart never shipped cell-text overlays in
+     * v22 so they need no migration here.
+     */
+    migratePercentBarCellText(state) {
+        const columns = state.StyledColumn?.StyledColumns;
+        if (!columns?.length) {
+            return;
+        }
+        for (const sc of columns) {
+            const percentBarStyle = sc.PercentBarStyle;
+            if (!percentBarStyle) {
+                continue;
+            }
+            const legacy = percentBarStyle;
+            if (legacy.CellText == undefined && legacy.CellTextPosition == undefined) {
+                continue;
+            }
+            const migrated = migrateLegacyPercentBarCellText(legacy);
+            delete legacy.CellText;
+            delete legacy.CellTextPosition;
+            if (migrated && !percentBarStyle.CellTextProperties) {
+                percentBarStyle.CellTextProperties = migrated;
+                this.logger.info(`Migrated v22 Percent Bar cell-text settings to per-value layout on column "${sc.ColumnId}" (v23).`);
+            }
+        }
+    }
     /**
      * `RowScope` (which row kinds — data / group / summary / total — render
      * the style) was originally a Badge-only concept. It applies equally to
@@ -71,6 +99,59 @@ export class VersionUpgrade23 extends VersionUpgrade {
      * Then delete the nested copy so we only have one source of truth going
      * forward.
      */
+    /**
+     * v22 Badge icon settings lived as four flat keys on
+     * `BadgeStyleDefinition`: `Icon`, `IconPosition`, `IconOnly` (and the
+     * v23 canary-only `IconGap`). v23 groups them under
+     * `IconProperties: { Icon, Position, Gap, IconOnly }`.
+     *
+     * Migration: per badge, if any of the flat keys are present, build
+     * `IconProperties` (renaming `IconPosition → Position` and `IconGap → Gap`,
+     * leaving `IconOnly` as-is) and strip the flat keys from the parent.
+     * `IconProperties.Icon` is required, so if the only flat fields set were
+     * decoration flags (`IconPosition` / `IconOnly` / `IconGap`) without an
+     * `Icon`, those flags are dropped (they had no effect anyway).
+     */
+    migrateBadgeIconProperties(state) {
+        const columns = state.StyledColumn?.StyledColumns;
+        if (!columns?.length) {
+            return;
+        }
+        for (const sc of columns) {
+            const badges = sc.BadgeStyle?.Badges;
+            if (!badges?.length) {
+                continue;
+            }
+            let didMigrate = false;
+            for (const badge of badges) {
+                const hasAnyFlatKey = badge.Icon !== undefined ||
+                    badge.IconPosition !== undefined ||
+                    badge.IconGap !== undefined ||
+                    badge.IconOnly !== undefined;
+                if (!hasAnyFlatKey) {
+                    continue;
+                }
+                if (badge.Icon && !badge.IconProperties) {
+                    const next = { Icon: badge.Icon };
+                    if (badge.IconPosition !== undefined)
+                        next.Position = badge.IconPosition;
+                    if (badge.IconGap !== undefined)
+                        next.Gap = badge.IconGap;
+                    if (badge.IconOnly !== undefined)
+                        next.IconOnly = badge.IconOnly;
+                    badge.IconProperties = next;
+                }
+                delete badge.Icon;
+                delete badge.IconPosition;
+                delete badge.IconGap;
+                delete badge.IconOnly;
+                didMigrate = true;
+            }
+            if (didMigrate) {
+                this.logger.info(`Migrated flat Badge icon settings to IconProperties on column "${sc.ColumnId}" (v23).`);
+            }
+        }
+    }
     liftBadgeStyleRowScope(state) {
         const columns = state.StyledColumn?.StyledColumns;
         if (!columns?.length) {

package/src/types.d.ts

@@ -194,7 +194,18 @@ export type { ExportState, Report, ReportData, ReportColumn, ReportSchedule, Sys
 export type { ColumnFilter, ColumnFilterPredicate, SystemFilterPredicateIds, SystemFilterPredicateId, PredicatesOperator, } from './AdaptableState/Common/ColumnFilter';
 export type { GridFilter } from './AdaptableState/Common/GridFilter';
 export type { FormatColumn, FormatColumnState, FormatColumnRule, FormatColumnPredicate, SystemFormatColumnPredicateId, SystemFormatColumnPredicateIds, ColumnGroupScope, FormatColumnTarget, FormatColumnConfig, } from './AdaptableState/FormatColumnState';
-export type { StyledColumn, StyledColumnState, PercentBarStyle, GradientStyle, GradientZeroCentredColors, CellColorRange, DynamicRangeEndpoint, ColumnComparison, CellTextOptions, CellTextOption, NumericStyledColumn, RangeValueType, SparklineStyle, BadgeStyle, BadgeStyleDefinition, BadgeStylePredicate, BadgeShape, BadgeDensity, BadgeOverflowMode, BadgePillStyle, SystemBadgeStylePredicateId, SystemBadgeStylePredicateIds, BulletChartStyle, BulletChartTarget, BulletChartTargetDefinition, BulletChartTargetMarker, RatingStyle, RatingIconShape, RangeBarStyle, RangeBarBound, RangeBarMarker, IconStyle, IconStyleMapping, IconStyleSpec, IconStyleMatchMode, IconStyleFallback, IconStyleBuiltInPreset, } from './AdaptableState/StyledColumnState';
+export type { StyledColumn, StyledColumnState } from './AdaptableState/StyledColumnState';
+export type { CellColorRange, ColumnComparison, DynamicRangeEndpoint, NumericStyledColumn, RangeValueType, } from './AdaptableState/StyledColumns/Common/NumericStyledColumn';
+export type { CellTextOption, CellTextOptions, } from './AdaptableState/StyledColumns/Common/CellTextOptions';
+export type { BarChartMarker } from './AdaptableState/StyledColumns/Common/BarChartMarker';
+export type { BadgeDensity, BadgeIconProperties, BadgeOverflowMode, BadgePillStyle, BadgeShape, BadgeStyle, BadgeStyleDefinition, BadgeStylePredicate, SystemBadgeStylePredicateId, SystemBadgeStylePredicateIds, } from './AdaptableState/StyledColumns/BadgeStyle';
+export type { BulletChartBarProperties, BulletChartStyle, BulletChartTarget, BulletChartTargetDefinition, BulletChartTargetProperties, } from './AdaptableState/StyledColumns/BulletChartStyle';
+export type { GradientStyle, GradientZeroCentredColors, } from './AdaptableState/StyledColumns/GradientStyle';
+export type { IconStyle, IconStyleBuiltInPreset, IconStyleFallback, IconStyleMapping, IconStyleMatchMode, IconStyleSpec, } from './AdaptableState/StyledColumns/IconStyle';
+export type { PercentBarStyle } from './AdaptableState/StyledColumns/PercentBarStyle';
+export type { RangeBarBound, RangeBarOutOfRangeProperties, RangeBarReferenceProperties, RangeBarStyle, RangeBarTrackProperties, } from './AdaptableState/StyledColumns/RangeBarStyle';
+export type { RatingIconShape, RatingStyle, } from './AdaptableState/StyledColumns/RatingStyle';
+export type { SparklineStyle } from './AdaptableState/StyledColumns/SparklineStyle';
 export type { FreeTextColumn, FreeTextColumnState, FreeTextStoredValue, FreeTextColumnSettings, } from './AdaptableState/FreeTextColumnState';
 export type { StatusBarState, AdaptableStatusBar } from './AdaptableState/StatusBarState';
 export type { IPushPullDomain, IPushPullReport, IPushPullState, } from './AdaptableState/IPushPullState';