@cdc/core 4.26.1 → 4.26.3

package/helpers/vegaConfigImport.ts

@@ -0,0 +1,160 @@
+/**
+ * Shared Vega-to-COVE conversion helper for stories.
+ */
+import {
+  convertVegaConfig,
+  getVegaConfigType,
+  getVegaErrors,
+  getVegaWarnings,
+  isVegaConfig,
+  parseVegaConfig
+} from './vegaConfig'
+
+/** Chart-type "button" definitions used to seed new COVE configs. */
+const buttons = [
+  {
+    id: 1,
+    category: 'Charts',
+    label: 'Bar',
+    type: 'chart',
+    subType: 'Bar',
+    orientation: 'vertical',
+    barThickness: '0.37',
+    visualizationSubType: 'regular',
+    xAxis: { type: 'categorical', size: 75, maxTickRotation: 45, labelOffset: 0 },
+    content: 'Use bars to show comparisons between data categories.'
+  },
+  {
+    id: 3,
+    category: 'Charts',
+    label: 'Combo Chart',
+    type: 'chart',
+    subType: 'Combo',
+    orientation: 'vertical',
+    content: 'Use bars to show comparisons between data categories.'
+  },
+  {
+    id: 4,
+    category: 'Charts',
+    label: 'Line',
+    type: 'chart',
+    subType: 'Line',
+    orientation: 'vertical',
+    content: 'Present one or more data trends over time.'
+  },
+  {
+    id: 6,
+    category: 'Charts',
+    label: 'Area Chart',
+    type: 'chart',
+    subType: 'Area Chart',
+    orientation: 'vertical',
+    content: 'Display an area chart to visualize quantities over time.'
+  },
+  {
+    id: 8,
+    category: 'Charts',
+    label: 'Scatter Plot',
+    type: 'chart',
+    subType: 'Scatter Plot',
+    orientation: 'vertical',
+    content: 'Display a scatter plot to explore relationships between numeric variables.'
+  },
+  {
+    id: 12,
+    category: 'Charts',
+    label: 'Horizontal Bar (Stacked)',
+    type: 'chart',
+    subType: 'Bar',
+    visualizationSubType: 'stacked',
+    orientation: 'horizontal',
+    content: 'Use bars to show comparisons between data categories.'
+  },
+  {
+    id: 19,
+    category: 'Maps',
+    label: 'United States (State- or County-Level)',
+    type: 'map',
+    subType: 'us',
+    content: 'Present a U.S. choropleth map at state or county level.',
+    position: 'right'
+  }
+]
+
+/** Build a seed COVE config from a button definition. */
+const generateNewConfig = (props: any) => {
+  let newConfig: any = {}
+  switch (props.category) {
+    case 'Charts': {
+      const visualizationType = props.subType
+      const visualizationSubType = !props.visualizationSubType ? 'regular' : props.visualizationSubType
+      newConfig = {
+        ...props,
+        visualizationType,
+        visualizationSubType,
+        newViz: true,
+        datasets: {}
+      }
+      break
+    }
+    case 'Maps': {
+      newConfig = { ...props, newViz: true, datasets: {}, type: 'map' }
+      newConfig['general'] = { geoType: props.subType, type: props?.generalType }
+      break
+    }
+  }
+  return newConfig
+}
+
+/**
+ * Convert a raw Vega/Vega-Lite config into a COVE config.
+ * Returns `null` if the config has errors.
+ */
+export const importVegaConfig = async (rawConfig: any): Promise<any | null> => {
+  const vegaConfig = await parseVegaConfig(rawConfig)
+  const vegaErrors = getVegaErrors(rawConfig, vegaConfig)
+  if (vegaErrors.length > 0) {
+    console.warn('Vega import errors:', vegaErrors)
+    return null
+  }
+
+  const configType = getVegaConfigType(vegaConfig)
+  const configSubType = configType === 'Map' ? 'United States (State- or County-Level)' : configType
+  const button = buttons.find(b => b.label === configSubType)
+  if (!button) {
+    console.warn(`No button found for config type "${configSubType}"`)
+    return null
+  }
+
+  const coveConfig = generateNewConfig(JSON.parse(JSON.stringify(button)))
+  try {
+    const warnings = getVegaWarnings(rawConfig, vegaConfig)
+    if (warnings.length) {
+      console.warn('Vega import warnings:', warnings)
+    }
+    const result = convertVegaConfig(configType, vegaConfig, coveConfig)
+
+    // Ensure imported Vega configs use the v1 qualitative palette so CdcChart
+    // doesn't apply v2 sequential-blue defaults (which would change the colors).
+    if (result && result.type !== 'map') {
+      result.general = result.general || {}
+      result.general.palette = {
+        name: 'qualitative-bold',
+        version: '1.0'
+      }
+    }
+
+    return result
+  } catch (err) {
+    console.error('Vega conversion error:', err)
+    return null
+  }
+}
+
+/** Check if a config is a Vega config and convert it; otherwise pass through. */
+export const maybeConvertVega = async (config: any): Promise<any | null> => {
+  if (isVegaConfig(config)) {
+    return importVegaConfig(config)
+  }
+  return config
+}

package/helpers/ver/4.24.4.ts

@@ -1,5 +1,28 @@
 import _ from 'lodash'
 import cloneConfig from '../cloneConfig'
+import { ConfigRow } from '@cdc/dashboard/src/types/ConfigRow'
+
+// Migrates rows from old array-of-arrays format to new { columns: [] } format.
+// Configs saved at exactly 4.24.3 have this format but the 4.24.3 migration
+// never runs for them (versionNeedsUpdate returns false when versions are equal).
+const remapDashboardRows = config => {
+  if (config.type === 'dashboard' && config.rows) {
+    config.rows = config.rows.map(row => {
+      if (row.columns === undefined) {
+        const newRow = {} as ConfigRow
+        const newColumns = row.map(column => {
+          newRow.uuid = column.uuid
+          newRow.toggle = column.toggle
+          newRow.equalHeight = column.equalHeight
+          return _.pick(column, 'equalHeight', 'width', 'hide', 'widget', 'uuid')
+        })
+        newRow.columns = newColumns
+        return newRow
+      }
+      return row
+    })
+  }
+}
 
 const addFiltersToTables = config => {
   if (config.type === 'dashboard') {
@@ -19,6 +42,7 @@ const update_4_24_4 = config => {
   const ver = '4.24.4'
 
   const newConfig = cloneConfig(config)
+  remapDashboardRows(newConfig)
   addFiltersToTables(newConfig)
 
   newConfig.version = ver

package/helpers/ver/4.26.1.ts

@@ -20,7 +20,7 @@ const removeOldBrushKeys = config => {
     delete config.brush
   }
 
-  if (config.type === 'dashboard') {
+  if (config.type === 'dashboard' && config.visualizations) {
     Object.values((config as DashboardConfig).visualizations).forEach(visualization => {
       removeOldBrushKeys(visualization)
     })

package/helpers/ver/4.26.2.ts

@@ -0,0 +1,84 @@
+import cloneConfig from '../cloneConfig'
+import { DashboardConfig } from '@cdc/dashboard/src/types/DashboardConfig'
+
+const migrateAnnotationDimensions = config => {
+  if (config.annotations && Array.isArray(config.annotations)) {
+    // Calculate chart area height for Y conversion (matches calcInitialHeight)
+    const isHorizontal = config.orientation === 'horizontal'
+    const chartAreaHeight = isHorizontal
+      ? Number(config.heights?.horizontal) || 750 // default horizontal height
+      : Number(config.heights?.vertical) || 300 // default vertical height
+
+    config.annotations = config.annotations.map(annotation => {
+      if (!annotation) return annotation
+      if (annotation.y !== undefined && chartAreaHeight > 0) {
+        // Convert Y from pixels to percentage using the chart area height
+        annotation.y = (annotation.y / chartAreaHeight) * 100
+      } else {
+        annotation.y = 50
+      }
+
+      // Delete savedDimensions to preserve old dx/dy behavior (fixed pixel offsets).
+      // The scaling function falls back to raw dx/dy when savedDimensions is missing.
+      // Once user drags the annotation, savedDimensions will be set with current chart
+      // dimensions, enabling responsive scaling from that point forward.
+      delete annotation.savedDimensions
+
+      return annotation
+    })
+  }
+
+  if (config.type === 'dashboard' && config.visualizations) {
+    Object.values((config as DashboardConfig).visualizations).forEach(visualization => {
+      migrateAnnotationDimensions(visualization)
+    })
+  }
+}
+
+const migrateAnnotationDataModel = config => {
+  if (config.annotations && Array.isArray(config.annotations)) {
+    config.annotations = config.annotations.map(annotation => {
+      if (!annotation) return annotation
+      // Set all existing annotations to fixed mode
+      annotation.anchorMode = 'fixed'
+
+      // Delete xKey entirely - old format stored timestamps for dates,
+      // but new dataX expects raw data values. Format is incompatible.
+      // User can re-enable data mode which will set fresh dataX value.
+      delete annotation.xKey
+
+      // Delete yKey entirely (Y will be calculated dynamically in data mode)
+      delete annotation.yKey
+
+      // Delete empty seriesKey - it would cause yScale(undefined) errors in data mode
+      if (!annotation.seriesKey) {
+        delete annotation.seriesKey
+      }
+
+      // Delete deprecated properties
+      delete annotation.snapToNearestPoint
+      delete annotation.originalX
+      delete annotation.originalDX
+      delete annotation.originalY
+
+      return annotation
+    })
+  }
+
+  if (config.type === 'dashboard' && config.visualizations) {
+    Object.values((config as DashboardConfig).visualizations).forEach(visualization => {
+      migrateAnnotationDataModel(visualization)
+    })
+  }
+}
+
+const update_4_26_2 = config => {
+  const ver = '4.26.2'
+  const newConfig = cloneConfig(config)
+  migrateAnnotationDimensions(newConfig)
+  migrateAnnotationDataModel(newConfig)
+  newConfig.version = ver
+  return newConfig
+}
+
+export default update_4_26_2

package/helpers/ver/4.26.3.ts

@@ -0,0 +1,44 @@
+import cloneConfig from '../cloneConfig'
+import { DashboardConfig } from '@cdc/dashboard/src/types/DashboardConfig'
+
+const addLocale = config => {
+  if (!config.locale) {
+    config.locale = 'en-US'
+  }
+
+  if (config.type === 'dashboard' && config.visualizations) {
+    Object.values((config as DashboardConfig).visualizations).forEach(visualization => {
+      addLocale(visualization)
+    })
+  }
+}
+
+const disableExtraChartVisualSettings = config => {
+  if (config.type === 'chart') {
+    config.visual = {
+      ...config.visual,
+      border: false,
+      borderColorTheme: false,
+      accent: false,
+      background: false,
+      hideBackgroundColor: false
+    }
+  }
+
+  if (config.type === 'dashboard' && config.visualizations) {
+    Object.values((config as DashboardConfig).visualizations).forEach(visualization => {
+      disableExtraChartVisualSettings(visualization)
+    })
+  }
+}
+
+const update_4_26_3 = config => {
+  const ver = '4.26.3'
+  const newConfig = cloneConfig(config)
+  addLocale(newConfig)
+  disableExtraChartVisualSettings(newConfig)
+  newConfig.version = ver
+  return newConfig
+}
+
+export default update_4_26_3

package/helpers/ver/4.26.4.ts

@@ -0,0 +1,31 @@
+import cloneConfig from '../cloneConfig'
+import { DashboardConfig } from '@cdc/dashboard/src/types/DashboardConfig'
+
+const disableExtraChartVisualSettings = config => {
+  if (config.type === 'chart') {
+    config.visual = {
+      ...config.visual,
+      border: false,
+      borderColorTheme: false,
+      accent: false,
+      background: false,
+      hideBackgroundColor: false
+    }
+  }
+
+  if (config.type === 'dashboard' && config.visualizations) {
+    Object.values((config as DashboardConfig).visualizations).forEach(visualization => {
+      disableExtraChartVisualSettings(visualization)
+    })
+  }
+}
+
+const update_4_26_4 = config => {
+  const ver = '4.26.4'
+  const newConfig = cloneConfig(config)
+  disableExtraChartVisualSettings(newConfig)
+  newConfig.version = ver
+  return newConfig
+}
+
+export default update_4_26_4

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

@@ -0,0 +1,105 @@
+import update_4_26_1 from '../4.26.1'
+import { expect, describe, it } from 'vitest'
+
+describe('update_4_26_1', () => {
+  describe('normalizeFilterParents', () => {
+    it('should convert string parents to array in shared filters', () => {
+      const config: any = {
+        type: 'dashboard',
+        version: '4.26.0',
+        dashboard: {
+          sharedFilters: [
+            {
+              type: 'datafilter',
+              parents: 'parent-filter-id'
+            }
+          ]
+        }
+      }
+
+      const result = update_4_26_1(config)
+
+      expect(result.dashboard.sharedFilters[0].parents).toEqual(['parent-filter-id'])
+      expect(result.version).toBe('4.26.1')
+    })
+
+    it('should leave array parents unchanged', () => {
+      const config: any = {
+        type: 'dashboard',
+        version: '4.26.0',
+        dashboard: {
+          sharedFilters: [
+            {
+              type: 'datafilter',
+              parents: ['parent1', 'parent2']
+            }
+          ]
+        }
+      }
+
+      const result = update_4_26_1(config)
+
+      expect(result.dashboard.sharedFilters[0].parents).toEqual(['parent1', 'parent2'])
+    })
+  })
+
+  describe('removeOldBrushKeys', () => {
+    it('should remove brush config from chart', () => {
+      const config: any = {
+        type: 'chart',
+        version: '4.26.0',
+        brush: { enabled: true }
+      }
+
+      const result = update_4_26_1(config)
+
+      expect(result.brush).toBeUndefined()
+    })
+
+    it('should remove brush config from dashboard visualizations', () => {
+      const config: any = {
+        type: 'dashboard',
+        version: '4.26.0',
+        visualizations: {
+          chart1: {
+            type: 'chart',
+            brush: { enabled: true }
+          }
+        }
+      }
+
+      const result = update_4_26_1(config)
+
+      expect(result.visualizations.chart1.brush).toBeUndefined()
+    })
+  })
+
+  describe('combined migrations', () => {
+    it('should run all migrations together', () => {
+      const config: any = {
+        type: 'dashboard',
+        version: '4.26.0',
+        dashboard: {
+          sharedFilters: [
+            {
+              type: 'datafilter',
+              parents: 'parent-id'
+            }
+          ]
+        },
+        visualizations: {
+          chart1: {
+            type: 'chart',
+            brush: { enabled: true }
+          }
+        }
+      }
+
+      const result = update_4_26_1(config)
+
+      expect(result.dashboard.sharedFilters[0].parents).toEqual(['parent-id'])
+      expect(result.visualizations.chart1.brush).toBeUndefined()
+      expect(result.version).toBe('4.26.1')
+    })
+  })
+})