@adaptabletools/adaptable 24.0.0-canary.0 → 24.0.0-canary.10

package/src/migration/AdaptableUpgradeHelper.d.ts

@@ -1,5 +1,5 @@
 import { VersionUpgrade } from './VersionUpgrade';
-import { AdaptableState } from '../AdaptableState/AdaptableState';
+import { AdaptablePersistentState } from '../AdaptableState/AdaptableState';
 import { LayoutTagOptions } from '../AdaptableOptions/LayoutOptions';
 /**
  * Config object used by State Auto-migration Wizard
@@ -38,7 +38,12 @@ export declare class AdaptableUpgradeHelper {
     protected versionUpgrades: Map<number, VersionUpgrade>;
     protected logger: MigrationLogger;
     private constructor();
-    static migrateAdaptableState(state: AdaptableState, config: UpgradeConfig): AdaptableState;
+    /**
+     * Migrates the given Adaptable State from `config.fromVersion` to `config.toVersion`.
+     *
+     * Accepts both a full `AdaptableState` and a (partial) `AdaptablePersistentState` - e.g. as received in `StateOptions.applyState()` - and returns the same shape.
+     */
+    static migrateAdaptableState<T extends Partial<AdaptablePersistentState>>(state: T, config: UpgradeConfig): T;
     /**
      * Published major version. When `VERSION` is not a parseable semver (local
      * builds and tests) this is 24, matching the previous helper fallback.

package/src/migration/VersionUpgrade17.js

@@ -91,7 +91,7 @@ export class VersionUpgrade17 extends VersionUpgrade {
         if (dashboardState?.VisibleButtons) {
             this.logger.warn(`Migrating deprecated DashboardState.VisibleButtons: [${dashboardState.VisibleButtons}].`);
             state.Dashboard.ModuleButtons = [
-                ...state.Dashboard.ModuleButtons,
+                ...(state.Dashboard.ModuleButtons ?? []),
                 ...dashboardState.VisibleButtons,
             ];
             delete state.Dashboard.VisibleButtons;
@@ -175,22 +175,24 @@ export class VersionUpgrade17 extends VersionUpgrade {
             return state;
         }
         const expression = oldQueryState.CurrentQuery;
-        const currentLayout = state.Layout.Layouts?.find((l) => l.Name === state.Layout.CurrentLayout);
+        const currentLayout = state.Layout?.Layouts?.find((l) => l.Name === state.Layout?.CurrentLayout);
         const currentGridFilter = currentLayout?.GridFilter;
         const currentGridFilterExpression = currentGridFilter && !currentGridFilter.IsSuspended ? currentGridFilter.Expression || '' : '';
-        if (expression && StringExtensions.IsNullOrEmpty(currentGridFilterExpression)) {
+        if (expression &&
+            currentLayout &&
+            StringExtensions.IsNullOrEmpty(currentGridFilterExpression)) {
             currentLayout.GridFilter = {
                 ...currentGridFilter,
                 Expression: expression,
             };
         }
-        state.Dashboard.Tabs?.forEach((tab) => {
+        state.Dashboard?.Tabs?.forEach((tab) => {
             if (tab.Toolbars.includes('Query')) {
                 tab.Toolbars = tab.Toolbars.map((t) => (t == 'Query' ? 'GridFilter' : t));
             }
         });
         let updatePinnedToolbars = false;
-        if (state.Dashboard.PinnedToolbars) {
+        if (state.Dashboard?.PinnedToolbars) {
             state.Dashboard.PinnedToolbars = state.Dashboard.PinnedToolbars.map((pinnedToolbar) => {
                 if (pinnedToolbar == 'Query') {
                     return 'GridFilter';
@@ -204,11 +206,12 @@ export class VersionUpgrade17 extends VersionUpgrade {
         const oldQueryState = state.Query;
         const oldNamedQueries = oldQueryState?.NamedQueries;
         if (ArrayExtensions.IsNotNullOrEmpty(oldNamedQueries)) {
-            const currentNamedQueries = state.NamedQuery.NamedQueries;
+            state.NamedQuery ??= {};
+            const currentNamedQueries = (state.NamedQuery.NamedQueries ??= []);
             oldNamedQueries.forEach((oldNamedQuery) => {
                 const currentQuery = currentNamedQueries.find((q) => q.Name === oldNamedQuery.Name);
                 if (!currentQuery) {
-                    state.NamedQuery?.NamedQueries?.push(oldNamedQuery);
+                    currentNamedQueries.push(oldNamedQuery);
                 }
             });
         }
@@ -236,6 +239,7 @@ export class VersionUpgrade17 extends VersionUpgrade {
             };
         })
             .filter(Boolean);
+        state.StyledColumn ??= {};
         state.StyledColumn.StyledColumns ??= [];
         styledColumns.forEach((styledColumn) => {
             state.StyledColumn.StyledColumns.push(styledColumn);
@@ -263,8 +267,9 @@ export class VersionUpgrade17 extends VersionUpgrade {
             }
         });
         const alertState = state.Alert;
-        if (ArrayExtensions.IsEmpty(state.FlashingCell?.FlashingCellDefinitions) &&
+        if (ArrayExtensions.IsNullOrEmpty(state.FlashingCell?.FlashingCellDefinitions) &&
             ArrayExtensions.IsNotNullOrEmpty(alertState?.FlashingAlertDefinitions)) {
+            state.FlashingCell ??= {};
             state.FlashingCell.FlashingCellDefinitions = alertState.FlashingAlertDefinitions;
             delete state.Alert.FlashingAlertDefinitions;
         }

package/src/migration/VersionUpgrade24.d.ts

@@ -33,6 +33,8 @@ import type { MigrationLogger } from './AdaptableUpgradeHelper';
  *    `Type: 'Change'` when missing
  * 16. {@link migrateLayoutTagsToRegistry} — Layout extensions held in object Tags
  *    (`layoutTagOptions.autoCheckTagsForLayouts`) → `Layout.LayoutExtensions`
+ * 17. {@link VersionUpgrade24.migrateSwatchColorVars} — `--ab-color-swatch-N`
+ *    colours → `--ab-color-palette-{N+12}`
  */
 export declare class VersionUpgrade24 extends VersionUpgrade {
     private options;
@@ -40,6 +42,13 @@ export declare class VersionUpgrade24 extends VersionUpgrade {
         layoutTagOptions?: LayoutTagOptions;
     });
     migrateState(state: AdaptableState): AdaptableState;
+    /**
+     * Step 17. The 20 swatch colours were merged into the palette after its 12
+     * light / dark pairs, so `var(--ab-color-swatch-N)` in any saved style
+     * (Format Columns, Styled Columns, Alerts, Flashing Cells, shared entities…)
+     * becomes `var(--ab-color-palette-{N+12})` with the same colour.
+     */
+    private migrateSwatchColorVars;
     /**
      * Migrates Notes from a single `Timestamp` to explicit `CreatedAt` / `UpdatedAt`.
      *

package/src/migration/VersionUpgrade24.js

@@ -34,8 +34,35 @@ export class VersionUpgrade24 extends VersionUpgrade {
         this.retypeObservableCalculatedColumns(state);
         this.stampFlashingCellTypes(state);
         migrateLayoutTagsToRegistry(state, this.logger, this.options.layoutTagOptions);
+        this.migrateSwatchColorVars(state);
         return state;
     }
+    migrateSwatchColorVars(state) {
+        const swatchVar = /--ab-color-swatch-(\d+)\b/g;
+        let rewritten = 0;
+        const visit = (node) => {
+            if (!node || typeof node !== 'object') {
+                return;
+            }
+            const container = node;
+            for (const key of Object.keys(container)) {
+                const value = container[key];
+                if (typeof value !== 'string') {
+                    visit(value);
+                    continue;
+                }
+                const next = value.replace(swatchVar, (_, n) => `--ab-color-palette-${Number(n) + 12}`);
+                if (next !== value) {
+                    container[key] = next;
+                    rewritten++;
+                }
+            }
+        };
+        visit(state);
+        if (rewritten > 0) {
+            this.logger.info(`Rewrote ${rewritten} colour value(s) from --ab-color-swatch-N to --ab-color-palette-{N+12} (v24).`);
+        }
+    }
     migrateNoteTimestamps(state) {
         const notes = state.Note?.Notes;
         if (!notes?.length) {

package/src/migration/legacyAdaptableQuery.d.ts

@@ -8,16 +8,41 @@ import type { ExpressionKind } from '../AdaptableState/Common/AdaptableQuery';
  * `Report.Query` are renamed to `Expression`.
  */
 export interface LegacyAdaptableQuery {
+    /**
+     * Per-row expression text. Current state stores this string directly on `Rule` or `Expression`.
+     */
     Expression?: string;
+    /**
+     * Aggregated expression text (a brace call). Current state stores the string directly; the kind is inferred.
+     */
     AggregatedExpression?: string;
+    /**
+     * Observable expression text. Current state stores the string directly and treats it as a scalar expression.
+     */
     ObservableExpression?: string;
-    /** @deprecated pre-v24 spelling of `Expression` */
+    /**
+     * Older name for {@link LegacyAdaptableQuery.Expression}.
+     *
+     * @deprecated pre-v24 spelling of `Expression`
+     */
     BooleanExpression?: string;
-    /** @deprecated pre-v24 spelling of `Expression` */
+    /**
+     * Older name for {@link LegacyAdaptableQuery.Expression}.
+     *
+     * @deprecated pre-v24 spelling of `Expression`
+     */
     ScalarExpression?: string;
-    /** @deprecated pre-v24 spelling of `AggregatedExpression` */
+    /**
+     * Older name for {@link LegacyAdaptableQuery.AggregatedExpression}.
+     *
+     * @deprecated pre-v24 spelling of `AggregatedExpression`
+     */
     AggregatedBooleanExpression?: string;
-    /** @deprecated pre-v24 spelling of `AggregatedExpression` */
+    /**
+     * Older name for {@link LegacyAdaptableQuery.AggregatedExpression}.
+     *
+     * @deprecated pre-v24 spelling of `AggregatedExpression`
+     */
     AggregatedScalarExpression?: string;
 }
 /** Either shape a `Rule` / `Query` may have in state being migrated. */