@adaptabletools/adaptable 20.0.0-canary.2 → 20.0.0-canary.20

package/src/migration/VersionUpgrade20.d.ts

@@ -1,7 +1,10 @@
 import { VersionUpgrade } from './VersionUpgrade';
 import { AdaptableState } from '../PredefinedConfig/AdaptableState';
+import { AdaptableColumnDataType } from '../PredefinedConfig/Common/AdaptableColumn';
+export declare function mapOldTypeToDataType(previousType: string): AdaptableColumnDataType;
 export declare class VersionUpgrade20 extends VersionUpgrade {
     migrateState(state: AdaptableState): AdaptableState;
     private migrateLayoutState;
     private migrateColTypeToDataType;
+    private migrateSparklineState;
 }

package/src/migration/VersionUpgrade20.js

@@ -2,20 +2,13 @@ import { VersionUpgrade } from './VersionUpgrade';
 import { ALL_ADAPTABLE_DATA_TYPES } from '../agGrid/agGridDataTypeDefinitions';
 function transition_pre_20(layout) {
     const l = layout;
-    if (l.AggregationColumns && !Array.isArray(l.AggregationColumns)) {
-        const oldAggs = l.AggregationColumns || {};
-        const newAggs = Object.entries(oldAggs).map(([colId, aggFunc]) => ({
-            ColumnId: colId,
-            AggFunc: aggFunc,
-        }));
-        layout.TableAggregationColumns = newAggs;
-    }
-    if (l.Columns) {
+    if (l.Columns && !l.EnablePivot) {
         layout.TableColumns = l.Columns;
         delete l.Columns;
+        delete layout.PivotColumns;
     }
     if (l.PinnedColumnsMap) {
-        layout.ColumnPinning = l.PinnedColumnsMap;
+        layout.ColumnPinning = { ...l.PinnedColumnsMap };
         delete l.PinnedColumnsMap;
     }
     if (l.ColumnHeadersMap) {
@@ -28,16 +21,82 @@ function transition_pre_20(layout) {
     }
     if (l.EnablePivot) {
         layout.PivotColumns = l.PivotColumns || [];
+        delete l.Columns;
+        delete layout.TableColumns;
+        delete l.EnablePivot;
         if (l.AggregationColumns) {
-            layout.PivotAggregationColumns = layout.TableAggregationColumns;
+            layout.PivotAggregationColumns = (Object.entries(l.AggregationColumns) || []).map(([ColumnId, AggFunc]) => {
+                return {
+                    ColumnId,
+                    AggFunc,
+                };
+            });
+            delete layout.TableAggregationColumns;
+            delete l.AggregationColumns;
+        }
+        if (l.RowGroupedColumns) {
+            layout.PivotGroupedColumns = l.RowGroupedColumns;
+            delete l.RowGroupedColumns;
+        }
+    }
+    else {
+        if (l.AggregationColumns && !Array.isArray(l.AggregationColumns)) {
+            const oldAggs = l.AggregationColumns || {};
+            const newAggs = Object.entries(oldAggs).map(([ColumnId, AggFunc]) => ({
+                ColumnId,
+                AggFunc,
+            }));
+            layout.TableAggregationColumns = newAggs;
+            delete l.AggregationColumns;
         }
     }
+    if (l.ExpandedRowGroupValues) {
+        layout.RowGroupValues = {
+            RowGroupDefaultBehavior: 'collapsed',
+            ExceptionGroupKeys: l.ExpandedRowGroupValues,
+        };
+        delete l.ExpandedRowGroupValues;
+    }
+    if (Array.isArray(l.ColumnFilters)) {
+        layout.ColumnFilters = l.ColumnFilters.map((columnFilter) => {
+            const filter = {
+                ...columnFilter,
+            };
+            // version 19 had a single predicate
+            // while version 20 has an array of predicates
+            // @ts-ignore
+            if (filter.Predicate) {
+                // @ts-ignore
+                filter.Predicates = [filter.Predicate];
+                // @ts-ignore
+                delete filter.Predicate;
+            }
+            if (!Array.isArray(filter.Predicates)) {
+                filter.Predicates = [];
+            }
+            filter.Predicates = filter.Predicates.map((p) => {
+                // the following predicate ids were renamed:
+                // Values -> In
+                if (p.PredicateId === 'Values') {
+                    p = { ...p };
+                    p.PredicateId = 'In';
+                }
+                // ExcludeValues -> NotIn
+                if (p.PredicateId === 'ExcludeValues') {
+                    p = { ...p };
+                    p.PredicateId = 'NotIn';
+                }
+                return p;
+            });
+            return filter;
+        });
+    }
     return layout;
 }
 function hasUpToDateDataType(dataType) {
     return ALL_ADAPTABLE_DATA_TYPES.includes(dataType);
 }
-function mapOldTypeToDataType(previousType) {
+export function mapOldTypeToDataType(previousType) {
     if (ALL_ADAPTABLE_DATA_TYPES.includes(previousType)) {
         return previousType;
     }
@@ -77,6 +136,7 @@ export class VersionUpgrade20 extends VersionUpgrade {
     migrateState(state) {
         this.migrateLayoutState(state);
         this.migrateColTypeToDataType(state);
+        this.migrateSparklineState(state);
         return state;
     }
     migrateLayoutState(state) {
@@ -127,4 +187,72 @@ export class VersionUpgrade20 extends VersionUpgrade {
             });
         }
     }
+    migrateSparklineState(state) {
+        this.logger.info(`Migration of Sparkline State`);
+        const sparklineState = state.StyledColumn;
+        if (sparklineState && sparklineState.StyledColumns) {
+            sparklineState.StyledColumns.forEach((styledColumn) => {
+                // @ts-ignore renamed 'SparkLineStyle' to 'SparklineStyle'
+                if (styledColumn.SparkLineStyle == undefined) {
+                    return;
+                }
+                // @ts-ignore renamed 'SparkLineStyle' to 'SparklineStyle'
+                // @ts-ignore
+                styledColumn.SparklineStyle = styledColumn.SparkLineStyle;
+                // @ts-ignore
+                delete styledColumn.SparkLineStyle;
+                // @ts-ignore the previous type was "column"
+                if (styledColumn.SparklineStyle?.options?.type === 'column') {
+                    // @ts-ignore the previous type was "column"
+                    styledColumn.SparklineStyle.options.type = 'bar';
+                    styledColumn.SparklineStyle.options.direction = 'vertical';
+                }
+                if (styledColumn.SparklineStyle?.options?.type === 'bar') {
+                    styledColumn.SparklineStyle.options.direction = 'horizontal';
+                }
+                if (styledColumn.SparklineStyle?.options?.line) {
+                    const previousLineOpts = (styledColumn.SparklineStyle?.options).line;
+                    styledColumn.SparklineStyle.options.stroke = previousLineOpts.stroke;
+                    styledColumn.SparklineStyle.options.strokeWidth = previousLineOpts.strokeWidth;
+                    delete styledColumn.SparklineStyle.options.line;
+                }
+                if (styledColumn.SparklineStyle?.options?.axis &&
+                    styledColumn.SparklineStyle?.options?.axis?.type == undefined) {
+                    styledColumn.SparklineStyle.options.axis.type = 'category';
+                }
+                if (styledColumn.SparklineStyle?.options?.highlightStyle) {
+                    const obsoleteKeys = ['fill', 'stroke', 'strokeWidth'];
+                    obsoleteKeys.forEach((obsoleteKey) => {
+                        if (
+                        // @ts-ignore
+                        styledColumn.SparklineStyle?.options?.highlightStyle?.[obsoleteKey] != undefined) {
+                            const itemHighlightStyle = styledColumn.SparklineStyle.options.highlightStyle.item ?? {};
+                            // @ts-ignore
+                            itemHighlightStyle[obsoleteKey] = styledColumn.SparklineStyle?.options
+                                ?.highlightStyle?.[obsoleteKey];
+                            // @ts-ignore
+                            delete styledColumn.SparklineStyle.options.highlightStyle[obsoleteKey];
+                        }
+                    });
+                }
+                if ((styledColumn.SparklineStyle?.options).paddingInner != undefined) {
+                    const axisOpts = (styledColumn.SparklineStyle.options.axis ?? {
+                        type: 'category',
+                    });
+                    axisOpts.paddingInner = (styledColumn.SparklineStyle?.options).paddingInner;
+                    delete (styledColumn.SparklineStyle?.options).paddingInner;
+                }
+                if ((styledColumn.SparklineStyle?.options).paddingOuter != undefined) {
+                    const axisOpts = (styledColumn.SparklineStyle.options.axis ?? {
+                        type: 'category',
+                    });
+                    axisOpts.paddingOuter = (styledColumn.SparklineStyle?.options).paddingOuter;
+                    delete (styledColumn.SparklineStyle?.options).paddingOuter;
+                }
+                if ((styledColumn.SparklineStyle?.options).marker != undefined) {
+                    (styledColumn.SparklineStyle?.options).marker.enabled = true;
+                }
+            });
+        }
+    }
 }

package/src/types.d.ts

@@ -20,7 +20,7 @@ export type { SetPrimaryKeyValueContext, RowFormOptions, RowFormContext, CreateR
 export type { AdaptableNumberCellEditorParams } from './agGrid/editors/AdaptableNumberEditor';
 export type { AdaptableDateEditorParams } from './agGrid/editors/AdaptableDateEditor';
 export type { AdaptablePercentageCellEditorParams } from './agGrid/editors/AdaptablePercentageEditor';
-export type { ExportOptions, SystemExportDestination, CustomDestination, ExternalReport, PreProcessExportContext, DataFormatType, ExportFormContext, ReportContext, ExportableColumnContext, ReportFileNameContext, DataFormatTypeContext, DataFormatDataType, ExportDestinationType, GetDetailRowsContext, BaseExportContext, ExportResultData, } from './AdaptableOptions/ExportOptions';
+export type { ExportOptions, SystemExportDestination, CustomDestination, ExternalReport, PreProcessExportContext, DataFormatType, ExportFormContext, ReportContext, ReportFileNameContext, DataFormatDataType, ExportDestinationType, GetDetailRowsContext, BaseExportContext, ExportResultData, } from './AdaptableOptions/ExportOptions';
 export type { DataImportValidationError, DataImportOptions, DataImportFileHandler, HandleImportedDataContext, DataImportValidateContext, GetPrimaryKeyValueContext, PreprocessRowDataContext, HandleImportedDataResolution, } from './AdaptableOptions/DataImportOptions';
 export type { DataSetOptions, DataSet, DataSetFormContext, } from './AdaptableOptions/DataSetOptions';
 export type { CellSummaryOptions } from './AdaptableOptions/CellSummaryOptions';
@@ -185,8 +185,8 @@ export type { AdaptableModule, AdaptableToolPanel, AdaptableQLModule, AdaptableS
 export type { ChartDefinition, ChartingState, ChartingAggFunc, } from './PredefinedConfig/ChartingState';
 export type { CustomSort, CustomSortState } from './PredefinedConfig/CustomSortState';
 export type { DashboardState, DashboardTab, AdaptableCoordinate, } from './PredefinedConfig/DashboardState';
-export type { ExportState, Report, ReportData, ReportSchedule, SystemReportName, SystemReportNames, SystemReportFormat, ReportRowScope, ReportColumnScope, ReportNameType, ReportFormatType, } from './PredefinedConfig/ExportState';
-export type { ColumnFilter, ColumnFilterPredicate, SystemFilterPredicateIds, SystemFilterPredicateId, } from './PredefinedConfig/Common/ColumnFilter';
+export type { ExportState, Report, ReportData, ReportColumn, ReportSchedule, SystemReportName, SystemReportNames, SystemReportFormat, ReportRowScope, ReportColumnScope, ReportNameType, ReportFormatType, } from './PredefinedConfig/ExportState';
+export type { ColumnFilter, ColumnFilterPredicate, SystemFilterPredicateIds, SystemFilterPredicateId, PredicatesOperator, } from './PredefinedConfig/Common/ColumnFilter';
 export type { GridFilter } from './PredefinedConfig/Common/GridFilter';
 export type { FormatColumn, FormatColumnState, FormatColumnRule, FormatColumnPredicate, SystemFormatColumnPredicateId, SystemFormatColumnPredicateIds, } from './PredefinedConfig/FormatColumnState';
 export type { StyledColumn, StyledColumnState, PercentBarStyle, GradientStyle, CellColorRange, ColumnComparison, CellTextOptions, CellTextOption, NumericStyledColumn, RangeValueType, SparklineStyle, BadgeStyle, BadgeStyleDefinition, BadgeStylePredicate, SystemBadgeStylePredicateId, SystemBadgeStylePredicateIds, } from './PredefinedConfig/StyledColumnState';