@adaptabletools/adaptable 23.0.5 → 23.0.6

package/src/View/Wizard/OnePageWizards.js

@@ -1,6 +1,7 @@
 import { jsx as _jsx, jsxs as _jsxs, Fragment as _Fragment } from "react/jsx-runtime";
 import * as React from 'react';
 import { useState, useRef } from 'react';
+import { useDispatch, useSelector } from 'react-redux';
 import { cn } from '../../lib/utils';
 import Dialog from '../../components/Dialog';
 import SimpleButton from '../../components/SimpleButton';
@@ -15,6 +16,9 @@ import { useKeyboardNavigation } from './useKeyboardNavigation';
 import { Box, Flex } from '../../components/Flex';
 import { twMerge } from '../../twMerge';
 import { targetOwn } from '../../components/twUtils';
+import { useAdaptable } from '../AdaptableContext';
+import { getMiddlePosition, getWizardSize } from '../Components/Popups/Utilities';
+import { SettingsPanelSet } from '../../Redux/ActionsReducers/InternalRedux';
 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) }));
@@ -113,7 +117,28 @@ export const OnePageWizard = (props) => {
     const canFinish = !invalidCount;
     const activeSection = visibleSections[currentSection];
     const activeSectionDetails = activeSection !== '-' ? activeSection?.details : undefined;
-    return (_jsx(NamedQueryContext.Provider, { value: { namedQuery, setNamedQuery }, children: _jsx(OnePageWizardContext.Provider, { value: contextValue, children: _jsx(Dialog, { modal: props.modal ?? true, isOpen: true, showCloseButton: false, focusOnBrowserVisible: true, className: "twa:rounded-standard twa:overflow-hidden twa:h-[90vh]", ref: dialogRef, onDismiss: () => props.onHide?.(), onKeyDown: (event) => {
+    const adaptable = useAdaptable();
+    const wizardOptions = adaptable.adaptableOptions.wizardOptions;
+    const isWindowMode = wizardOptions?.popupType === 'window' && props.modal !== false;
+    const wizardSettingsKey = `wizard-${props.name || 'unnamed'}`;
+    const dispatch = useDispatch();
+    const persistedWizardSettings = useSelector((state) => state?.Internal?.SettingsPanel?.[wizardSettingsKey]);
+    let windowModalProps;
+    if (isWindowMode) {
+        const size = persistedWizardSettings?.size ?? wizardOptions?.size ?? getWizardSize();
+        const position = persistedWizardSettings?.position ?? wizardOptions?.position ?? getMiddlePosition(size);
+        windowModalProps = {
+            handleSelector: '.ab-OnePageWizard__header',
+            minHeight: 460,
+            minWidth: 400,
+            size,
+            position,
+            onChange: (settings) => {
+                dispatch(SettingsPanelSet(wizardSettingsKey, settings));
+            },
+        };
+    }
+    return (_jsx(NamedQueryContext.Provider, { value: { namedQuery, setNamedQuery }, children: _jsx(OnePageWizardContext.Provider, { value: contextValue, children: _jsx(Dialog, { modal: isWindowMode ? false : props.modal ?? true, windowModal: isWindowMode, windowModalProps: windowModalProps, fixed: !isWindowMode, isOpen: true, showCloseButton: false, focusOnBrowserVisible: true, className: cn('twa:rounded-standard twa:overflow-hidden', isWindowMode ? 'twa:h-full' : 'twa:h-[90vh]'), ref: dialogRef, onDismiss: () => props.onHide?.(), onKeyDown: (event) => {
                     if (event.metaKey || event.ctrlKey) {
                         const { key } = event;
                         if (!isNaN(Number(key))) {
@@ -129,7 +154,7 @@ export const OnePageWizard = (props) => {
                             }
                         }
                     }
-                }, children: _jsxs(Box, { className: cn('ab-OnePageWizard twa:flex twa:flex-col twa:h-full twa:w-[90vw] twa:max-w-[1200px]', 'twa:bg-primarylight twa:text-primary-foreground'), "data-name": props.name, style: props.style, children: [(props.moduleName || activeSectionDetails) && (_jsxs(Box, { className: cn('ab-OnePageWizard__header', ONE_PAGE_WIZARD_SECTION_GRID, 'twa:items-start twa:my-3 twa:px-2'), children: [_jsx(Box, { className: "ab-OnePageWizard__module-name twa:min-w-0 twa:pl-3 twa:font-bold", children: props.moduleName }), _jsx(Box, { className: "ab-OnePageWizard__details twa:min-w-0 twa:pr-2 twa:text-4", children: activeSectionDetails })] })), _jsx(Box, { as: "hr", className: "ab-OnePageWizard__module-separator twa:w-full twa:border-0 twa:border-t twa:border-t-input-border twa:mb-2" }), _jsxs(Box, { className: cn(ONE_PAGE_WIZARD_SECTION_GRID, 'twa:flex-1 twa:min-h-0 twa:overflow-auto twa:items-stretch'), children: [_jsxs(Flex, { flexDirection: "column", className: "ab-OnePageWizard__section-title-container twa:min-h-0 twa:min-w-0 twa:overflow-auto twa:p-3 twa:relative", ref: sizeOwnerRef, style: props.titleContainerStyle, children: [visibleSections.map((section, index) => {
+                }, children: _jsxs(Box, { className: cn('ab-OnePageWizard twa:flex twa:flex-col twa:h-full', isWindowMode ? 'twa:w-full' : 'twa:w-[90vw] twa:max-w-[1200px]', 'twa:bg-primarylight twa:text-primary-foreground'), "data-name": props.name, style: props.style, children: [(props.moduleName || activeSectionDetails) && (_jsxs(Box, { className: cn('ab-OnePageWizard__header', ONE_PAGE_WIZARD_SECTION_GRID, 'twa:items-start twa:my-3 twa:px-2'), children: [_jsx(Box, { className: "ab-OnePageWizard__module-name twa:min-w-0 twa:pl-3 twa:font-bold", children: props.moduleName }), _jsx(Box, { className: "ab-OnePageWizard__details twa:min-w-0 twa:pr-2 twa:text-4", children: activeSectionDetails })] })), _jsx(Box, { as: "hr", className: "ab-OnePageWizard__module-separator twa:w-full twa:border-0 twa:border-t twa:border-t-input-border twa:mb-2" }), _jsxs(Box, { className: cn(ONE_PAGE_WIZARD_SECTION_GRID, 'twa:flex-1 twa:min-h-0 twa:overflow-auto twa:items-stretch'), children: [_jsxs(Flex, { flexDirection: "column", className: "ab-OnePageWizard__section-title-container twa:min-h-0 twa:min-w-0 twa:overflow-auto twa:p-3 twa:relative", ref: sizeOwnerRef, style: props.titleContainerStyle, children: [visibleSections.map((section, index) => {
                                             if (section === '-') {
                                                 return (_jsx(Box, { as: "hr", className: "ab-OnePageWizard__section-separator twa:mt-2 twa:w-full twa:border-t twa:border-t-input-border" }, `${index}-`));
                                             }

package/src/agGrid/AdaptableAgGrid.js

@@ -81,6 +81,7 @@ import { ONLY_AGG_FN_NAME, WEIGHTED_AVERAGE_AGG_FN_NAME, } from '../AdaptableSta
 import { RowFormService } from '../Utilities/Services/RowFormService';
 import { ADAPTABLE_PUBLISH_TIMESTAMP } from '../EnvVars';
 import { AdaptableUpgradeHelper } from '../migration/AdaptableUpgradeHelper';
+import { stripDeprecatedStateKeys } from '../migration/DeprecatedStateKeys';
 import { ensureLoadingScreenPortalElement } from '../components/Modal';
 import { AdaptableLoadingScreen } from '../View/Components/Popups/AdaptableLoadingScreen';
 import { createElement } from 'react';
@@ -521,6 +522,7 @@ export class AdaptableAgGrid {
         });
     }
     normalizeAdaptableState(state, agGridOptions) {
+        state = stripDeprecatedStateKeys(state, this.logger);
         state = this.normaliseLayoutState(state, agGridOptions);
         state = this.normaliseToolPanelState(state);
         return state;

package/src/env.js

@@ -1,5 +1,5 @@
 export default {
     NEXT_PUBLIC_INFINITE_TABLE_LICENSE_KEY: "StartDate=2021-06-29|EndDate=2030-01-01|Owner=Adaptable|Type=distribution|TS=1624971462479|C=137829811,1004007071,2756196225,1839832928,3994409405,636616862" || '',
-    PUBLISH_TIMESTAMP: 1782478280705 || Date.now(),
-    VERSION: "23.0.5" || '--current-version--',
+    PUBLISH_TIMESTAMP: 1782917265348 || Date.now(),
+    VERSION: "23.0.6" || '--current-version--',
 };

package/src/migration/DeprecatedStateKeys.d.ts

@@ -0,0 +1,37 @@
+import { AdaptableLogger } from '../agGrid/AdaptableLogger';
+export interface DeprecatedStateKeyInfo {
+    /** AdapTable major version in which the key was removed from `AdaptableState`. */
+    removedInVersion: number;
+    /**
+     * Optional short pointer to the replacement feature(s). Only appended to the
+     * info message when the deprecated slice actually had content (i.e. the
+     * value is a non-empty object). Empty slices — e.g. someone leaving
+     * `Schedule: {}` in their `initialState` — get the base message only, since
+     * they have nothing to migrate.
+     */
+    replacement?: string;
+}
+/**
+ * Top-level `AdaptableState` keys that used to exist but have since been
+ * removed from AdapTable's state shape.
+ *
+ * On load, `stripDeprecatedStateKeys` quietly removes any of these keys from
+ * the incoming state and logs a single friendly `info` line per key — instead
+ * of letting Redux's `combineReducers` surface its more alarming
+ * `Unexpected key "…" found in previous state received by the reducer` warning.
+ *
+ * When you drop a top-level state slice, add it here so upgrading users with
+ * either an older persisted state or a stale `initialState` block in their
+ * `AdaptableOptions` see a soft, actionable message rather than a raw Redux
+ * dev-tools warning.
+ */
+export declare const DEPRECATED_TOP_LEVEL_STATE_KEYS: Readonly<Record<string, DeprecatedStateKeyInfo>>;
+/**
+ * Remove any known-deprecated top-level keys from an incoming state object and
+ * log a friendly `info` message per stripped key. Unknown keys are left alone
+ * so Redux still surfaces genuinely unexpected state entries.
+ *
+ * Returns a shallow-cloned state with the deprecated keys removed, or the
+ * original state reference when nothing needed stripping.
+ */
+export declare function stripDeprecatedStateKeys<T extends Record<string, any>>(state: T, logger?: Pick<AdaptableLogger, 'consoleInfo'>): T;

package/src/migration/DeprecatedStateKeys.js

@@ -0,0 +1,42 @@
+export const DEPRECATED_TOP_LEVEL_STATE_KEYS = {
+    Schedule: {
+        removedInVersion: 23,
+        replacement: 'Use Scheduled Alerts for time-based triggers, or move Report schedules onto Export state.',
+    },
+};
+const INTERNAL_STATE_METADATA_KEYS = new Set([
+    'Uuid',
+    'AdaptableVersion',
+    'Source',
+    'Revision',
+]);
+export function stripDeprecatedStateKeys(state, logger) {
+    if (!state || typeof state !== 'object') {
+        return state;
+    }
+    let cleanedState = state;
+    let didStrip = false;
+    for (const [key, info] of Object.entries(DEPRECATED_TOP_LEVEL_STATE_KEYS)) {
+        const value = state[key];
+        if (value === undefined) {
+            continue;
+        }
+        if (!didStrip) {
+            cleanedState = { ...state };
+            didStrip = true;
+        }
+        delete cleanedState[key];
+        const hasContent = value !== null &&
+            typeof value === 'object' &&
+            Object.keys(value).some((k) => !INTERNAL_STATE_METADATA_KEYS.has(k));
+        const message = `Deprecated state key "${key}" was removed in AdapTable v${info.removedInVersion} and will be ignored.` +
+            (hasContent && info.replacement ? ` ${info.replacement}` : '');
+        if (logger?.consoleInfo) {
+            logger.consoleInfo(message);
+        }
+        else {
+            console.info(message);
+        }
+    }
+    return cleanedState;
+}

package/src/migration/VersionUpgrade23.d.ts

@@ -2,6 +2,15 @@ import { VersionUpgrade } from './VersionUpgrade';
 import { AdaptableState } from '../AdaptableState/AdaptableState';
 export declare class VersionUpgrade23 extends VersionUpgrade {
     migrateState(state: AdaptableState): AdaptableState;
+    /**
+     * Logs a one-line summary of each populated sub-collection on the legacy
+     * `Schedule` slice so users can see exactly what they had before v23 removed
+     * the slice. The actual key removal is done later by
+     * `stripDeprecatedStateKeys` (in `normalizeAdaptableState`) so that the
+     * friendly "Schedule was removed…" info line always fires whenever `Schedule`
+     * is present — even when the slice is empty (e.g. someone left
+     * `Schedule: {}` in their `initialState`) or when `autoMigrateState` is off.
+     */
     private migrateSchedulingState;
     /**
      * v22 Percent Bar stored cell-text overlay settings as flat

package/src/migration/VersionUpgrade23.js

@@ -43,8 +43,7 @@ export class VersionUpgrade23 extends VersionUpgrade {
         if (removedReminderCount > 0) {
             this.logger.info(`Removed ${removedReminderCount} legacy Reminders from Schedule state.`);
         }
-        const { Schedule: _removed, ...stateWithoutSchedule } = state;
-        return stateWithoutSchedule;
+        return state;
     }
     migratePercentBarCellText(state) {
         const columns = state.StyledColumn?.StyledColumns;

package/src/types.d.ts

@@ -51,7 +51,8 @@ export type { ToolPanelOptions, CustomToolPanel, ToolPanelButtonContext, CustomT
 export type { UserInterfaceOptions, LoadingScreenOptions, ObjectTagsContext, CustomIcon, } from './AdaptableOptions/UserInterfaceOptions';
 export type { ContextMenuOptions, AdaptableSystemContextMenuItem, CustomContextMenuContext, CustomContextMenuItem, UserContextMenuItem, AgGridContextMenuItemType, DefaultAdaptableMenuStructure, DefaultAgGridMenuStructure, CustomGroupContextMenuItem, } from './AdaptableOptions/ContextMenuOptions';
 export type { ColumnMenuOptions, CustomColumnMenuContext, CustomColumnMenuItem, UserColumnMenuItem, AdaptableSystemColumnMenuItem, AgGridColumnMenuItemType, CustomGroupColumnMenuItem, } from './AdaptableOptions/ColumnMenuOptions';
-export type { CustomSettingsPanel, SettingsPanelOptions, SettingsPanelNavigation, SettingsPanelNavigationGroup, SettingsPanelNavigationContext, SettingsPanelNavigationConfigurer, LegacyFlatSettingsPanelNavigation, SettingsPanelPosition, SettingsPanelSize, PopupType, } from './AdaptableOptions/SettingsPanelOptions';
+export type { CustomSettingsPanel, SettingsPanelOptions, SettingsPanelNavigation, SettingsPanelNavigationGroup, SettingsPanelNavigationContext, SettingsPanelNavigationConfigurer, LegacyFlatSettingsPanelNavigation, PopupType, } from './AdaptableOptions/SettingsPanelOptions';
+export type { WizardOptions } from './AdaptableOptions/WizardOptions';
 export type { EntitlementOptions, EntitlementContext, DefaultAccessLevelContext, } from './AdaptableOptions/EntitlementOptions';
 export type { EvaluateExpressionExternallyContext, ExpressionOptions, ModuleExpressionFunctions, ModuleExpressionFunctionsMap, GlobalExpressionFunctionsContext, ModuleExpressionFunctionsContext, CustomQueryVariableContext, QueryableColumnContext, AdaptableFieldContext, } from './AdaptableOptions/ExpressionOptions';
 export type { PredicateOptions, SystemPredicatesContext, } from './AdaptableOptions/PredicateOptions';
@@ -231,5 +232,6 @@ export type { Fdc3Options, GridDataContextMapping, ActionColumnDefaultConfigurat
 export type { CommentState, CommentThread, AdaptableComment } from './AdaptableState/CommentState';
 export type { UpgradeConfig } from '../agGrid';
 export type { ProgressIndicatorConfig } from './AdaptableState/Common/ProgressIndicatorConfig';
-export type { CustomWindowConfig, WindowPosition, WindowSize, } from './AdaptableState/Common/CustomWindowConfig';
+export type { CustomWindowConfig } from './AdaptableState/Common/CustomWindowConfig';
+export type { WindowPosition, WindowSize } from './AdaptableState/Common/Window';
 export type { TransposeConfig } from './AdaptableState/Common/TransposeConfig';