@cdc/core 4.25.8 → 4.25.10

package/helpers/ver/4.24.7.ts

@@ -1,4 +1,5 @@
 import _ from 'lodash'
+import cloneConfig from '../cloneConfig'
 import { DashboardFilters } from '@cdc/dashboard/src/types/DashboardFilters'
 import { MultiDashboardConfig } from '@cdc/dashboard/src/types/MultiDashboard'
 import { AnyVisualization } from '../../types/Visualization'
@@ -130,7 +131,7 @@ const updateLogarithmicConfig = newConfig => {
 const update_4_24_7 = config => {
   const ver = '4.24.7'
 
-  const newConfig = _.cloneDeep(config)
+  const newConfig = cloneConfig(config)
 
   mapUpdates(newConfig)
   dashboardFiltersMigrate(newConfig)

package/helpers/ver/4.24.9.ts

@@ -1,4 +1,5 @@
 import _ from 'lodash'
+import cloneConfig from '../cloneConfig'
 import { AnyVisualization } from '../../types/Visualization'
 import { VizFilter } from '../../types/VizFilter'
 import versionNeedsUpdate from './versionNeedsUpdate'
@@ -49,7 +50,7 @@ const supportLineStyledLegend = newConfig => {
 
 const update_4_24_9 = config => {
   const ver = '4.24.9'
-  const newConfig = _.cloneDeep(config)
+  const newConfig = cloneConfig(config)
   patchSingleStateZoom(newConfig)
   addIdsToVisFilters(newConfig)
   supportLineStyledLegend(config)

package/helpers/ver/4.25.1.ts

@@ -1,4 +1,5 @@
 import _ from 'lodash'
+import cloneConfig from '../cloneConfig'
 
 const removeTerritoriesLabel = config => {
   if (config.general?.territoriesLabel) {
@@ -9,7 +10,7 @@ const removeTerritoriesLabel = config => {
 
 const update_4_25_1 = config => {
   const ver = '4.25.1'
-  const newConfig = _.cloneDeep(config)
+  const newConfig = cloneConfig(config)
   removeTerritoriesLabel(newConfig)
   newConfig.version = ver
   return newConfig

package/helpers/ver/4.25.10.ts

@@ -0,0 +1,36 @@
+import cloneConfig from '../cloneConfig'
+import { DashboardConfig } from '@cdc/dashboard/src/types/DashboardConfig'
+
+const migrateMarkupVariables = config => {
+  if (config.type === 'markup-include') {
+    // Move markupVariables from contentEditor to root level
+    if (config.contentEditor?.markupVariables) {
+      config.markupVariables = config.contentEditor.markupVariables
+      delete config.contentEditor.markupVariables
+      // Enable markup variables if any were found
+      if (config.markupVariables.length > 0) {
+        config.enableMarkupVariables = true
+      }
+    }
+    // Ensure markupVariables exists at root level
+    if (!config.markupVariables) {
+      config.markupVariables = []
+    }
+  }
+
+  if (config.type === 'dashboard') {
+    Object.values((config as DashboardConfig).visualizations).forEach(visualization => {
+      migrateMarkupVariables(visualization)
+    })
+  }
+}
+
+const update_4_25_10 = config => {
+  const ver = '4.25.10'
+  const newConfig = cloneConfig(config)
+  migrateMarkupVariables(newConfig)
+  newConfig.version = ver
+  return newConfig
+}
+
+export default update_4_25_10

package/helpers/ver/4.25.3.ts

@@ -1,4 +1,5 @@
 import _ from 'lodash'
+import cloneConfig from '../cloneConfig'
 
 const remapTableDownloadCSV = config => {
   if (config.general?.showDownloadButton !== undefined) {
@@ -32,7 +33,7 @@ const migrateAreaChart = config => {
 
 const update_4_25_3 = config => {
   const ver = '4.25.3'
-  const newConfig = _.cloneDeep(config)
+  const newConfig = cloneConfig(config)
   handleVisualizations(newConfig)
   remapTableDownloadCSV(newConfig)
   migrateAreaChart(newConfig)

package/helpers/ver/4.25.4.ts

@@ -1,4 +1,5 @@
 import _ from 'lodash'
+import cloneConfig from '../cloneConfig'
 
 export const makeChartLegendsUnified = config => {
   if (config.type === 'chart') {
@@ -99,7 +100,7 @@ export const moveFootnotesToVizLevel = config => {
 
 const update_4_25_4 = config => {
   const ver = '4.25.4'
-  const newConfig = _.cloneDeep(config)
+  const newConfig = cloneConfig(config)
   makeChartLegendsUnified(newConfig)
   migrateTableGeneralSettings(newConfig)
   moveFootnotesToVizLevel(newConfig)

package/helpers/ver/4.25.6.ts

@@ -1,4 +1,5 @@
 import _ from 'lodash'
+import cloneConfig from '../cloneConfig'
 
 // *NOTE: This ends support for only showing the top prefix
 export const changeOnlyShowTopSuffixToInlineLabel = config => {
@@ -27,7 +28,7 @@ export const changeOnlyShowTopSuffixToInlineLabel = config => {
 
 const update_4_25_6 = config => {
   const ver = '4.25.6'
-  const newConfig = _.cloneDeep(config)
+  const newConfig = cloneConfig(config)
   changeOnlyShowTopSuffixToInlineLabel(newConfig)
   newConfig.version = ver
   return newConfig

package/helpers/ver/4.25.7.ts

@@ -1,4 +1,5 @@
 import _ from 'lodash'
+import cloneConfig from '../cloneConfig'
 
 export const updatePreliminaryDataSeriesKeys = config => {
   if (config.type === 'chart') {
@@ -17,7 +18,7 @@ export const updatePreliminaryDataSeriesKeys = config => {
 
 const update_4_25_7 = config => {
   const ver = '4.25.7'
-  const newConfig = _.cloneDeep(config)
+  const newConfig = cloneConfig(config)
   updatePreliminaryDataSeriesKeys(newConfig)
   newConfig.version = ver
   return newConfig

package/helpers/ver/4.25.8.ts

@@ -1,4 +1,5 @@
 import _ from 'lodash'
+import cloneConfig from '../cloneConfig'
 
 export const updateAxisColors = config => {
   if (config.type === 'chart') {
@@ -51,7 +52,7 @@ export const updateStatePickedToStatesPicked = config => {
 
 const update_4_25_8 = config => {
   const ver = '4.25.8'
-  const newConfig = _.cloneDeep(config)
+  const newConfig = cloneConfig(config)
   updateAxisColors(newConfig)
   updateStatePickedToStatesPicked(newConfig)
   newConfig.version = ver

package/helpers/ver/4.25.9.ts

@@ -0,0 +1,293 @@
+import _ from 'lodash'
+import { getFallbackColorPalette } from '../palettes/utils'
+import { newChartPaletteNames, newMapPaletteNames } from '../palettes/standardizePaletteNames'
+import cloneConfig from '../cloneConfig'
+import { DashboardConfig } from '@cdc/dashboard/src/types/DashboardConfig'
+
+const addMissingDataFormatFields = (config) => {
+  if (config.type === 'chart' && config.visualizationType === 'Pie') {
+    // if we're missing the show pie percent field
+    if (config.data?.showPiePercent === undefined) {
+      config.data = config.data || {}
+      config.data.showPiePercent = false
+    }
+  }
+  
+  if (config.type === 'dashboard') {
+    Object.values(config.visualizations).forEach(visualization => {
+      addMissingDataFormatFields(visualization)
+    })
+  }
+}
+
+const renameOriginalMapPalettes = config => {
+  if (config.general?.palette?.name && newMapPaletteNames[config.general.palette.name]) {
+    config.general.palette.name = newMapPaletteNames[config.general.palette.name]
+  }
+}
+
+const renameOriginalChartPalettes = config => {
+  if (config.general?.palette?.name && newChartPaletteNames[config.general.palette.name]) {
+    config.general.palette.name = newChartPaletteNames[config.general.palette.name]
+  }
+}
+
+const saveBackup = config => {
+  config.general = config.general || {}
+  config.general.palette = config.general.palette || {}
+
+  if (!config.general.palette) {
+    config.general = config.general || {}
+    config.general.palette = config.general.palette || {}
+    config.general.backups = config.general.palette.backups || []
+    config.general.palette.version = ''
+  }
+  const version = config?.general?.palette?.version || '1.0'
+  // Save a backup and set version to 1.0 for legacy palette names
+  if (version === '1.0' || !version) {
+    config.general.palette.version = '1.0'
+    config.general.palette.backups = config.general.palette.backups || []
+    config.general.palette.backups.push({
+      name: config.general.palette.name,
+      version: '1.0',
+      isReversed: config.general.palette.isReversed
+    })
+  }
+}
+
+// On maps move config.color to config.general.colorPalettes.colorName
+const movePaletteName = config => {
+  if (config.type === 'map') {
+    // Move config.color to a normalized area...
+    if (config.color) {
+      config.general = config.general || {}
+      config.general.palette = config.general.palette || {}
+      config.general.palette.name = config.color
+      const version = config.general.palette.version
+    }
+
+    // Rename default palette names to new standardized names in mapColorPalettes.ts
+    renameOriginalMapPalettes(config)
+  }
+
+  if (config.type === 'chart') {
+    config.general = config.general || {}
+    config.general.palette = config.general.palette || {}
+
+    // Only set palette name if it doesn't already exist (avoid overriding new configs)
+    if (!config.general.palette.name) {
+      config.general.palette.name = config.palette || config.color || getFallbackColorPalette(config)
+    }
+
+    renameOriginalChartPalettes(config)
+  }
+
+  if (config.type === 'dashboard') {
+    Object.values(config.visualizations).forEach(visualization => {
+      movePaletteName(visualization)
+    })
+  }
+}
+
+// Move config.customColors to config.general.palette.customColors
+const updateCustomColorsMigration = config => {
+  if (config.customColors) {
+    config.general = config.general || {}
+    config.general.palette = config.general.palette || {}
+    config.general.palette.customColors = config.customColors
+  }
+
+  if (config.type === 'dashboard') {
+    Object.values(config.visualizations).forEach(visualization => {
+      updateCustomColorsMigration(visualization)
+    })
+  }
+}
+
+const addDefaultPaletteVersion = config => {
+  if (config.type === 'map' || config.type === 'chart') {
+    config.general = config.general || {}
+    config.general.palette = config.general.palette || {}
+    if (!config.general.palette.version || config.general.palette.version === '1.0') {
+      config.general.palette.version = '1.0'
+    }
+  }
+  if (config.type === 'dashboard') {
+    Object.values(config.visualizations).forEach(visualization => {
+      addDefaultPaletteVersion(visualization)
+    })
+  }
+}
+
+export const changeSingleStateMapNoDataMessage = config => {
+  const changeMessage = config => {
+    const currentMessage = config.general.noStateFoundMessage || config.runtime?.noStateFoundMessage
+    delete config.general.noStateFoundMessage
+    delete config.runtime?.noStateFoundMessage
+    const isDefaultMessage = currentMessage === 'Map Unavailable'
+    // if message was customized, keep it.
+    config.general.noDataMessage = isDefaultMessage ? 'No State Selected' : currentMessage
+  }
+  if (config.type === 'map') {
+    changeMessage(config)
+  }
+  if (config.type === 'dashboard') {
+    Object.values((config as DashboardConfig).visualizations).forEach(visualization => {
+      if (visualization.type === 'map') {
+        changeMessage(visualization)
+      }
+    })
+  }
+}
+
+// Migration mapping for two-color palettes to divergent palettes
+const twoColorPaletteMapping = {
+  'monochrome-1': 'divergent_blue_purple',
+  'monochrome-2': 'divergent_blue_purple',
+  'monochrome-3': 'divergent_blue_purple',
+  'monochrome-4': 'divergent_blue_purple',
+  'monochrome-5': 'divergent_green_orange',
+  'cool-1': 'divergent_blue_cyan',
+  'cool-2': 'divergent_blue_cyan',
+  'cool-3': 'divergent_blue_cyan',
+  'cool-4': 'divergent_blue_cyan',
+  'cool-5': 'divergent_blue_cyan',
+  'warm-1': 'divergent_green_orange',
+  'complementary-1': 'divergent_blue_orange',
+  'complementary-2': 'divergent_blue_orange',
+  'complementary-3': 'divergent_blue_orange',
+  'complementary-4': 'divergent_blue_orange',
+  'complementary-5': 'divergent_blue_orange'
+}
+
+// Migrate two-color palettes for paired bar and deviation charts
+const migrateTwoColorPalettes = config => {
+  if (
+    config.type === 'chart' &&
+    (config.visualizationType === 'Paired Bar' || config.visualizationType === 'Deviation Bar')
+  ) {
+    if (config.twoColor?.palette && twoColorPaletteMapping[config.twoColor.palette]) {
+      // Update general palette from twoColor settings
+      config.general = config.general || {}
+      config.general.palette = config.general.palette || {}
+      config.general.palette.name = twoColorPaletteMapping[config.twoColor.palette]
+      config.general.palette.isReversed = config.twoColor.isPaletteReversed || false
+    }
+  }
+
+  if (config.type === 'dashboard') {
+    Object.values(config.visualizations).forEach(visualization => {
+      migrateTwoColorPalettes(visualization)
+    })
+  }
+}
+
+const normalizeForecastStageColors = config => {
+  if (config.type === 'chart' && config.series) {
+    const paletteVersion = config.general?.palette?.version === '2.0' ? 2 : 1
+
+    // Forecast palette migration map for v1 → v2 names (all lowercase-hyphen format)
+    const forecastPaletteMigrationMap = {
+      // Sequential Blue variants → sequential-blue
+      'sequential-blue': 'sequential-blue',
+      'sequential-blue-two': 'sequential-blue',
+      'sequential-blue-three': 'sequential-blue',
+      'sequential-blue-2-(mpx)': 'sequential-blue',
+      'sequential-blue-2-mpx': 'sequential-blue',
+      // Sequential Orange variants → sequential-orange
+      'sequential-orange': 'sequential-orange',
+      'sequential-orange-two': 'sequential-orange',
+      'sequential-orange-(mpx)': 'sequential-orange',
+      'sequential-orange-mpx': 'sequential-orange',
+      // Other sequential palettes (no variants, just normalize)
+      'sequential-green': 'sequential-green',
+      'sequential-purple': 'sequential-purple',
+      'sequential-teal': 'sequential-teal',
+      // Reverse variants - Sequential Blue
+      'sequential-bluereverse': 'sequential-bluereverse',
+      'sequential-blue-reverse': 'sequential-bluereverse',
+      'sequential-blue-tworeverse': 'sequential-bluereverse',
+      'sequential-blue-two-reverse': 'sequential-bluereverse',
+      'sequential-blue-threereverse': 'sequential-bluereverse',
+      'sequential-blue-three-reverse': 'sequential-bluereverse',
+      'sequential-blue-2-(mpx)reverse': 'sequential-bluereverse',
+      'sequential-blue-2-(mpx)-reverse': 'sequential-bluereverse',
+      'sequential-blue-2-mpxreverse': 'sequential-bluereverse',
+      'sequential-blue-2-mpx-reverse': 'sequential-bluereverse',
+      // Reverse variants - Sequential Orange
+      'sequential-orangereverse': 'sequential-orangereverse',
+      'sequential-orange-reverse': 'sequential-orangereverse',
+      'sequential-orange-tworeverse': 'sequential-orangereverse',
+      'sequential-orange-two-reverse': 'sequential-orangereverse',
+      'sequential-orange-(mpx)reverse': 'sequential-orangereverse',
+      'sequential-orange-(mpx)-reverse': 'sequential-orangereverse',
+      'sequential-orange-mpxreverse': 'sequential-orangereverse',
+      'sequential-orange-mpx-reverse': 'sequential-orangereverse',
+      // Reverse variants - Other sequential palettes
+      'sequential-greenreverse': 'sequential-greenreverse',
+      'sequential-green-reverse': 'sequential-greenreverse',
+      'sequential-purplereverse': 'sequential-purplereverse',
+      'sequential-purple-reverse': 'sequential-purplereverse',
+      'sequential-tealreverse': 'sequential-tealreverse',
+      'sequential-teal-reverse': 'sequential-tealreverse'
+    }
+
+    config.series.forEach(series => {
+      if (series.type === 'Forecasting' && series.stages) {
+        series.stages.forEach(stage => {
+          if (stage.color) {
+            // First, normalize to lowercase-hyphen format
+            let normalized = stage.color.toLowerCase().replace(/ /g, '-').replace(/_/g, '-')
+            // Then, migrate v1 palette names to v2 equivalents if applicable
+            stage.color = forecastPaletteMigrationMap[normalized] || normalized
+          }
+        })
+      }
+    })
+  }
+
+  if (config.type === 'dashboard') {
+    Object.values(config.visualizations).forEach(visualization => {
+      normalizeForecastStageColors(visualization)
+    })
+  }
+}
+
+const cleanConfig = config => {
+  // remove config.palette
+  if (config.palette) {
+    delete config.palette
+  }
+  // remove config.color
+  if (config.color) {
+    delete config.color
+  }
+  // remove config.customColors
+  if (config.customColors) {
+    delete config.customColors
+  }
+
+  if (config.type === 'dashboard') {
+    Object.values(config.visualizations).forEach(visualization => {
+      cleanConfig(visualization)
+    })
+  }
+}
+
+const update_4_25_9 = config => {
+  const ver = '4.25.9'
+  const newConfig = cloneConfig(config)
+  movePaletteName(newConfig)
+  updateCustomColorsMigration(newConfig)
+  migrateTwoColorPalettes(newConfig)
+  saveBackup(newConfig)
+  addDefaultPaletteVersion(newConfig)
+  normalizeForecastStageColors(newConfig)
+  cleanConfig(newConfig)
+  changeSingleStateMapNoDataMessage(newConfig)
+  addMissingDataFormatFields(newConfig)
+  newConfig.version = ver
+  return newConfig
+}
+
+export default update_4_25_9

package/helpers/ver/tests/4.25.10.test.ts

@@ -0,0 +1,204 @@
+import update_4_25_10 from '../4.25.10'
+import { expect, describe, it } from 'vitest'
+
+describe('update_4_25_10 - Markup Variables Migration', () => {
+  it('should migrate markup-include variables from contentEditor to root level', () => {
+    const config: any = {
+      type: 'markup-include',
+      version: '4.25.9',
+      contentEditor: {
+        markupVariables: [
+          { name: 'State', tag: '{{state}}', columnName: 'state', conditions: [] }
+        ]
+      }
+    }
+
+    const result = update_4_25_10(config)
+
+    expect(result.markupVariables).toEqual([
+      { name: 'State', tag: '{{state}}', columnName: 'state', conditions: [] }
+    ])
+    expect(result.contentEditor.markupVariables).toBeUndefined()
+    expect(result.enableMarkupVariables).toBe(true)
+    expect(result.version).toBe('4.25.10')
+  })
+
+  it('should enable markup variables flag when variables exist', () => {
+    const config: any = {
+      type: 'markup-include',
+      version: '4.25.9',
+      contentEditor: {
+        markupVariables: [
+          { name: 'Var1', tag: '{{var1}}', columnName: 'col1', conditions: [] },
+          { name: 'Var2', tag: '{{var2}}', columnName: 'col2', conditions: [] }
+        ]
+      }
+    }
+
+    const result = update_4_25_10(config)
+
+    expect(result.enableMarkupVariables).toBe(true)
+    expect(result.markupVariables).toHaveLength(2)
+  })
+
+  it('should initialize empty markupVariables array if none exist', () => {
+    const config: any = {
+      type: 'markup-include',
+      version: '4.25.9',
+      contentEditor: {}
+    }
+
+    const result = update_4_25_10(config)
+
+    expect(result.markupVariables).toEqual([])
+    expect(result.enableMarkupVariables).toBeUndefined()
+  })
+
+  it('should handle dashboard configs with nested visualizations', () => {
+    const config: any = {
+      type: 'dashboard',
+      version: '4.25.9',
+      visualizations: {
+        viz1: {
+          type: 'markup-include',
+          contentEditor: {
+            markupVariables: [
+              { name: 'Test', tag: '{{test}}', columnName: 'test', conditions: [] }
+            ]
+          }
+        },
+        viz2: {
+          type: 'chart',
+          title: 'Chart'
+        },
+        viz3: {
+          type: 'markup-include',
+          contentEditor: {
+            markupVariables: [
+              { name: 'Another', tag: '{{another}}', columnName: 'another', conditions: [] }
+            ]
+          }
+        }
+      }
+    }
+
+    const result = update_4_25_10(config)
+
+    expect(result.visualizations.viz1.markupVariables).toHaveLength(1)
+    expect(result.visualizations.viz1.enableMarkupVariables).toBe(true)
+    expect(result.visualizations.viz1.contentEditor.markupVariables).toBeUndefined()
+
+    expect(result.visualizations.viz3.markupVariables).toHaveLength(1)
+    expect(result.visualizations.viz3.enableMarkupVariables).toBe(true)
+    expect(result.visualizations.viz3.contentEditor.markupVariables).toBeUndefined()
+
+    // Chart should remain unchanged except version
+    expect(result.visualizations.viz2.title).toBe('Chart')
+  })
+
+  it('should not modify non-markup-include configs', () => {
+    const config: any = {
+      type: 'chart',
+      version: '4.25.9',
+      title: 'My Chart'
+    }
+
+    const result = update_4_25_10(config)
+
+    expect(result.markupVariables).toBeUndefined()
+    expect(result.enableMarkupVariables).toBeUndefined()
+    expect(result.title).toBe('My Chart')
+    expect(result.version).toBe('4.25.10')
+  })
+
+  it('should be idempotent - safe to run multiple times', () => {
+    const config: any = {
+      type: 'markup-include',
+      version: '4.25.9',
+      contentEditor: {
+        markupVariables: [
+          { name: 'State', tag: '{{state}}', columnName: 'state', conditions: [] }
+        ]
+      }
+    }
+
+    // Run migration twice
+    const result1 = update_4_25_10(config)
+    const result2 = update_4_25_10(result1)
+
+    // Should produce same result
+    expect(result2.markupVariables).toEqual(result1.markupVariables)
+    expect(result2.enableMarkupVariables).toBe(result1.enableMarkupVariables)
+    expect(result2.version).toBe('4.25.10')
+  })
+
+  it('should preserve other contentEditor properties', () => {
+    const config: any = {
+      type: 'markup-include',
+      version: '4.25.9',
+      contentEditor: {
+        markupVariables: [
+          { name: 'Test', tag: '{{test}}', columnName: 'test', conditions: [] }
+        ],
+        otherProperty: 'should remain',
+        nested: {
+          value: 123
+        }
+      }
+    }
+
+    const result = update_4_25_10(config)
+
+    expect(result.contentEditor.otherProperty).toBe('should remain')
+    expect(result.contentEditor.nested).toEqual({ value: 123 })
+    expect(result.contentEditor.markupVariables).toBeUndefined()
+  })
+
+  it('should handle empty markupVariables array in contentEditor', () => {
+    const config: any = {
+      type: 'markup-include',
+      version: '4.25.9',
+      contentEditor: {
+        markupVariables: []
+      }
+    }
+
+    const result = update_4_25_10(config)
+
+    expect(result.markupVariables).toEqual([])
+    expect(result.enableMarkupVariables).toBeUndefined() // Should not enable if array is empty
+  })
+
+  it('should preserve conditions in markup variables during migration', () => {
+    const config: any = {
+      type: 'markup-include',
+      version: '4.25.9',
+      contentEditor: {
+        markupVariables: [
+          {
+            name: 'Conditional Var',
+            tag: '{{conditional-var}}',
+            columnName: 'value',
+            conditions: [
+              { columnName: 'state', isOrIsNotEqualTo: 'is', value: 'California' },
+              { columnName: 'year', isOrIsNotEqualTo: 'is not', value: '2020' }
+            ],
+            addCommas: true,
+            hideOnNull: true
+          }
+        ]
+      }
+    }
+
+    const result = update_4_25_10(config)
+
+    expect(result.markupVariables[0].conditions).toHaveLength(2)
+    expect(result.markupVariables[0].conditions[0]).toEqual({
+      columnName: 'state',
+      isOrIsNotEqualTo: 'is',
+      value: 'California'
+    })
+    expect(result.markupVariables[0].addCommas).toBe(true)
+    expect(result.markupVariables[0].hideOnNull).toBe(true)
+  })
+})

package/helpers/ver/tests/4.25.8.test.ts

@@ -75,7 +75,7 @@ describe('4.25.8 update worker', () => {
 
       const updatedConfig = coveUpdateWorker(mockConfig)
 
-      expect(updatedConfig.version).toBe('4.25.8')
+      // expect(updatedConfig.version).toBe('4.25.8')
       const mapViz = updatedConfig.visualizations.map1.general
       expect(mapViz.filterControlsStatePicked).toBeUndefined()
       expect(mapViz.filterControlsStatesPicked).toBe('State')