@adaptabletools/adaptable-cjs 20.0.0-canary.1 → 20.0.0-canary.11

package/src/migration/VersionUpgrade20.d.ts

@@ -4,4 +4,5 @@ export declare class VersionUpgrade20 extends VersionUpgrade {
     migrateState(state: AdaptableState): AdaptableState;
     private migrateLayoutState;
     private migrateColTypeToDataType;
+    private migrateSparklineState;
 }

package/src/migration/VersionUpgrade20.js

@@ -5,8 +5,8 @@ const VersionUpgrade_1 = require("./VersionUpgrade");
 const agGridDataTypeDefinitions_1 = require("../agGrid/agGridDataTypeDefinitions");
 function transition_pre_20(layout) {
     const l = layout;
-    if (l.TableAggregationColumns && !Array.isArray(l.TableAggregationColumns)) {
-        const oldAggs = l.TableAggregationColumns || {};
+    if (l.AggregationColumns && !Array.isArray(l.AggregationColumns)) {
+        const oldAggs = l.AggregationColumns || {};
         const newAggs = Object.entries(oldAggs).map(([colId, aggFunc]) => ({
             ColumnId: colId,
             AggFunc: aggFunc,
@@ -31,10 +31,44 @@ function transition_pre_20(layout) {
     }
     if (l.EnablePivot) {
         layout.PivotColumns = l.PivotColumns || [];
-        if (l.TableAggregationColumns) {
+        if (l.AggregationColumns) {
             layout.PivotAggregationColumns = layout.TableAggregationColumns;
         }
     }
+    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) {
@@ -80,6 +114,7 @@ class VersionUpgrade20 extends VersionUpgrade_1.VersionUpgrade {
     migrateState(state) {
         this.migrateLayoutState(state);
         this.migrateColTypeToDataType(state);
+        this.migrateSparklineState(state);
         return state;
     }
     migrateLayoutState(state) {
@@ -130,5 +165,73 @@ class VersionUpgrade20 extends VersionUpgrade_1.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;
+                }
+            });
+        }
+    }
 }
 exports.VersionUpgrade20 = VersionUpgrade20;

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, } 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';
@@ -150,7 +150,7 @@ export type { CellSummmaryInfo, CustomCellSummaryOperation, CustomCellSummaryOpe
 export type { FlashingCellDefinition, FlashingCellState, SystemFlashingCellPredicateId, SystemFlashingCellPredicateIds, } from './PredefinedConfig/FlashingCellState';
 export type { AdaptableAlert, AdaptableAlertType, AdaptableGenericAlert, AdaptableCellChangedAlert, AdaptableRowChangedAlert, AdaptableAlertBase, } from './PredefinedConfig/Common/AdaptableAlert';
 export type { AdaptableFlashingCell } from './PredefinedConfig/Common/AdaptableFlashingCell';
-export type { AdaptableColumn, AdaptableColumnBase, AdaptableColumnType, AdaptableColumnDataType, AdaptableColumnGroup, } from './PredefinedConfig/Common/AdaptableColumn';
+export type { AdaptableColumn, AdaptableColumnBase, AdaptableSpecialColumnType, AdaptableColumnDataType, AdaptableColumnGroup, } from './PredefinedConfig/Common/AdaptableColumn';
 export type { AdaptableField } from './PredefinedConfig/Common/AdaptableField';
 export type { AdaptableComparerFunction } from './PredefinedConfig/Common/AdaptableComparerFunction';
 export type { SystemStatusMessageInfo } from './PredefinedConfig/Common/SystemStatusMessageInfo';
@@ -185,7 +185,7 @@ 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 { ExportState, Report, ReportData, ReportColumn, ReportSchedule, SystemReportName, SystemReportNames, SystemReportFormat, ReportRowScope, ReportColumnScope, ReportNameType, ReportFormatType, } from './PredefinedConfig/ExportState';
 export type { ColumnFilter, ColumnFilterPredicate, SystemFilterPredicateIds, SystemFilterPredicateId, } from './PredefinedConfig/Common/ColumnFilter';
 export type { GridFilter } from './PredefinedConfig/Common/GridFilter';
 export type { FormatColumn, FormatColumnState, FormatColumnRule, FormatColumnPredicate, SystemFormatColumnPredicateId, SystemFormatColumnPredicateIds, } from './PredefinedConfig/FormatColumnState';