@cdc/core 4.26.1 → 4.26.3

package/helpers/tests/abbreviateNumber.test.ts

@@ -0,0 +1,59 @@
+import { describe, it, expect } from 'vitest'
+import { abbreviateNumber } from '../cove/number'
+
+describe('abbreviateNumber', () => {
+  describe('default (English) abbreviations', () => {
+    it('abbreviates thousands with K', () => {
+      expect(abbreviateNumber(1500)).toBe('1.5K')
+    })
+
+    it('abbreviates millions with M', () => {
+      expect(abbreviateNumber(2500000)).toBe('2.5M')
+    })
+
+    it('abbreviates billions with B', () => {
+      expect(abbreviateNumber(3000000000)).toBe('3B')
+    })
+
+    it('does not abbreviate numbers below 1000', () => {
+      expect(abbreviateNumber(999)).toBe('999')
+    })
+
+    it('handles negative numbers', () => {
+      expect(abbreviateNumber(-5000)).toBe('-5K')
+    })
+  })
+
+  describe('en-US locale abbreviations', () => {
+    it('uses K/M/B for en-US', () => {
+      expect(abbreviateNumber(1500, 'en-US')).toBe('1.5K')
+      expect(abbreviateNumber(2500000, 'en-US')).toBe('2.5M')
+      expect(abbreviateNumber(3000000000, 'en-US')).toBe('3B')
+    })
+  })
+
+  describe('es-MX locale abbreviations', () => {
+    it('uses " mil" for thousands in Spanish', () => {
+      expect(abbreviateNumber(1500, 'es-MX')).toBe('1.5 mil')
+    })
+
+    it('uses " M" for millions in Spanish', () => {
+      expect(abbreviateNumber(2500000, 'es-MX')).toBe('2.5 M')
+    })
+
+    it('uses " mil M" for billions in Spanish', () => {
+      expect(abbreviateNumber(3000000000, 'es-MX')).toBe('3 mil M')
+    })
+
+    it('does not abbreviate numbers below 1000 in Spanish', () => {
+      expect(abbreviateNumber(999, 'es-MX')).toBe('999')
+    })
+  })
+
+  describe('unknown locale', () => {
+    it('falls back to English K/M/B for unknown locale', () => {
+      expect(abbreviateNumber(1500, 'xx-XX')).toBe('1.5K')
+      expect(abbreviateNumber(2500000, 'xx-XX')).toBe('2.5M')
+    })
+  })
+})

package/helpers/tests/backfillDefaults.test.ts

@@ -0,0 +1,253 @@
+import { backfillDefaults } from '../backfillDefaults'
+import { expect, describe, it } from 'vitest'
+import { LEGACY_CHART_DEFAULTS } from '@cdc/chart/src/data/legacy-defaults'
+import { LEGACY_MAP_DEFAULTS } from '@cdc/map/src/data/legacy-defaults'
+import chartDefaults from '@cdc/chart/src/data/initial-state'
+import mapDefaults from '@cdc/map/src/data/initial-state'
+
+// ============================================================================
+// backfillDefaults — pure function tests
+// ============================================================================
+
+describe('backfillDefaults', () => {
+  it('fills missing properties from defaults into config', () => {
+    const config = { yAxis: { hideLabel: false } }
+    const defaults = { yAxis: { hideLabel: true, gridLines: true, numTicks: 4 } }
+    backfillDefaults(config, defaults)
+    expect(config.yAxis.gridLines).toBe(true)
+    expect(config.yAxis.numTicks).toBe(4)
+  })
+
+  it('preserves existing config values including falsy ones', () => {
+    const config = {
+      yAxis: { hideAxis: false, numTicks: '', gridLines: false },
+      dataFormat: { commas: false },
+      table: { expanded: 0 }
+    }
+    const defaults = {
+      yAxis: { hideAxis: true, numTicks: 4, gridLines: true },
+      dataFormat: { commas: true },
+      table: { expanded: false }
+    }
+    backfillDefaults(config, defaults)
+    expect(config.yAxis.hideAxis).toBe(false)
+    expect(config.yAxis.numTicks).toBe('')
+    expect(config.yAxis.gridLines).toBe(false)
+    expect(config.dataFormat.commas).toBe(false)
+    expect(config.table.expanded).toBe(0)
+  })
+
+  it('preserves null config values (does not overwrite with default)', () => {
+    const config = { yAxis: { numTicks: null } }
+    const defaults = { yAxis: { numTicks: 4 } }
+    backfillDefaults(config, defaults)
+    expect(config.yAxis.numTicks).toBeNull()
+  })
+
+  it('skips arrays and primitive top-level keys', () => {
+    const config = { filters: [], title: 'My Chart', yAxis: { hideAxis: false } } as any
+    const defaults = { filters: [{ name: 'default' }], title: 'Default', yAxis: { hideAxis: true, numTicks: 4 } }
+    backfillDefaults(config, defaults)
+    expect(config.filters).toEqual([])
+    expect(config.title).toBe('My Chart')
+    expect(config.yAxis.numTicks).toBe(4)
+  })
+
+  it('skips top-level keys that exist in defaults but not in config', () => {
+    const config = { yAxis: { hideAxis: false } } as any
+    const defaults = { yAxis: { hideAxis: true }, legend: { position: 'top' } }
+    backfillDefaults(config, defaults)
+    expect(config.legend).toBeUndefined()
+  })
+
+  it('legacy changed-value entries override new defaults for missing properties', () => {
+    const config = { yAxis: {} } as any
+    const defaults = { yAxis: { numTicks: 6 } }
+    const legacy = { yAxis: { numTicks: '' } }
+    backfillDefaults(config, defaults, legacy)
+    expect(config.yAxis.numTicks).toBe('')
+  })
+
+  it('legacy undefined entries prevent backfill entirely', () => {
+    const config = { xAxis: {} } as any
+    const defaults = { xAxis: { dateDisplayFormat: '%b. %-d %Y' } }
+    const legacy = { xAxis: { dateDisplayFormat: undefined } }
+    backfillDefaults(config, defaults, legacy)
+    expect(config.xAxis.dateDisplayFormat).toBeUndefined()
+    expect('dateDisplayFormat' in config.xAxis).toBe(false)
+  })
+
+  it('legacy is ignored when config already has the property', () => {
+    const config = { yAxis: { numTicks: 10 } }
+    const defaults = { yAxis: { numTicks: 6 } }
+    const legacy = { yAxis: { numTicks: '' } }
+    backfillDefaults(config, defaults, legacy)
+    expect(config.yAxis.numTicks).toBe(10)
+  })
+
+  it('no legacy arg falls back to defaults normally', () => {
+    const config = { yAxis: {} } as any
+    const defaults = { yAxis: { numTicks: 6 } }
+    backfillDefaults(config, defaults)
+    expect(config.yAxis.numTicks).toBe(6)
+  })
+
+  it('empty legacy object falls back to defaults normally', () => {
+    const config = { yAxis: {} } as any
+    const defaults = { yAxis: { numTicks: 6 } }
+    backfillDefaults(config, defaults, {})
+    expect(config.yAxis.numTicks).toBe(6)
+  })
+
+  it('works with multiple sections in a single call', () => {
+    const config = { yAxis: {}, xAxis: {}, legend: {} } as any
+    const defaults = {
+      yAxis: { numTicks: 4 },
+      xAxis: { numTicks: 6 },
+      legend: { position: 'top' }
+    }
+    backfillDefaults(config, defaults)
+    expect(config.yAxis.numTicks).toBe(4)
+    expect(config.xAxis.numTicks).toBe(6)
+    expect(config.legend.position).toBe('top')
+  })
+})
+
+// ============================================================================
+// Chart legacy defaults protection
+// ============================================================================
+
+describe('chart legacy defaults protection', () => {
+  it('old config with yAxis.numTicks: "" keeps "" (not replaced with 4)', () => {
+    const config = { yAxis: { numTicks: '' } }
+    backfillDefaults(config, chartDefaults, LEGACY_CHART_DEFAULTS)
+    expect(config.yAxis.numTicks).toBe('')
+  })
+
+  it('old config with yAxis.hideAxis: false keeps false (not replaced with true)', () => {
+    const config = { yAxis: { hideAxis: false } }
+    backfillDefaults(config, chartDefaults, LEGACY_CHART_DEFAULTS)
+    expect(config.yAxis.hideAxis).toBe(false)
+  })
+
+  it('old config with yAxis.gridLines: false keeps false (not replaced with true)', () => {
+    const config = { yAxis: { gridLines: false } }
+    backfillDefaults(config, chartDefaults, LEGACY_CHART_DEFAULTS)
+    expect(config.yAxis.gridLines).toBe(false)
+  })
+
+  it('old config with yAxis.hideTicks: false keeps false (not replaced with true)', () => {
+    const config = { yAxis: { hideTicks: false } }
+    backfillDefaults(config, chartDefaults, LEGACY_CHART_DEFAULTS)
+    expect(config.yAxis.hideTicks).toBe(false)
+  })
+
+  it('old config with xAxis.numTicks: "" keeps "" (not replaced with 6)', () => {
+    const config = { xAxis: { numTicks: '' } }
+    backfillDefaults(config, chartDefaults, LEGACY_CHART_DEFAULTS)
+    expect(config.xAxis.numTicks).toBe('')
+  })
+
+  it('old config missing xAxis.viewportNumTicks does NOT get { xs: 4, xxs: 4 }', () => {
+    const config = { xAxis: { numTicks: '' } } as any
+    backfillDefaults(config, chartDefaults, LEGACY_CHART_DEFAULTS)
+    expect(config.xAxis.viewportNumTicks).toBeUndefined()
+  })
+
+  it('old config missing xAxis.dateDisplayFormat does NOT get the new default', () => {
+    const config = { xAxis: { numTicks: '' } } as any
+    backfillDefaults(config, chartDefaults, LEGACY_CHART_DEFAULTS)
+    expect(config.xAxis.dateDisplayFormat).toBeUndefined()
+  })
+
+  it('old config with table.expanded: true keeps true (not replaced with false)', () => {
+    const config = { table: { expanded: true } }
+    backfillDefaults(config, chartDefaults, LEGACY_CHART_DEFAULTS)
+    expect(config.table.expanded).toBe(true)
+  })
+
+  it('old config with legend.position: "right" keeps "right" (not replaced with "top")', () => {
+    const config = { legend: { position: 'right' } }
+    backfillDefaults(config, chartDefaults, LEGACY_CHART_DEFAULTS)
+    expect(config.legend.position).toBe('right')
+  })
+
+  it('old config with dataFormat.commas: false keeps false (not replaced with true)', () => {
+    const config = { dataFormat: { commas: false } }
+    backfillDefaults(config, chartDefaults, LEGACY_CHART_DEFAULTS)
+    expect(config.dataFormat.commas).toBe(false)
+  })
+
+  it('old config with tooltips.dateDisplayFormat: "" keeps "" (not replaced with new format)', () => {
+    const config = { tooltips: { dateDisplayFormat: '' } }
+    backfillDefaults(config, chartDefaults, LEGACY_CHART_DEFAULTS)
+    expect(config.tooltips.dateDisplayFormat).toBe('')
+  })
+
+  it('new config (no properties set) gets all the new defaults correctly', () => {
+    const config = {
+      yAxis: {},
+      xAxis: {},
+      table: {},
+      legend: {},
+      dataFormat: {},
+      tooltips: {},
+      general: {}
+    } as any
+    backfillDefaults(config, chartDefaults, LEGACY_CHART_DEFAULTS)
+
+    expect(config.yAxis.hideAxis).toBe(false)
+    expect(config.yAxis.hideTicks).toBe(false)
+    expect(config.yAxis.gridLines).toBe(false)
+    expect(config.yAxis.numTicks).toBe('')
+    expect(config.table.expanded).toBe(true)
+    expect(config.table.dateDisplayFormat).toBe('')
+    expect(config.legend.position).toBe('right')
+    expect(config.dataFormat.commas).toBe(false)
+    expect(config.tooltips.dateDisplayFormat).toBe('')
+    expect(config.xAxis.numTicks).toBe('')
+    // New properties should NOT be backfilled for old configs
+    expect(config.xAxis.dateDisplayFormat).toBeUndefined()
+    expect(config.xAxis.viewportNumTicks).toBeUndefined()
+    expect(config.general.useIntelligentLineChartLabels).toBeUndefined()
+  })
+})
+
+// ============================================================================
+// Map legacy defaults protection
+// ============================================================================
+
+describe('map legacy defaults protection', () => {
+  it('old config with legend.style: "circles" keeps "circles" (not replaced with "gradient")', () => {
+    const config = { legend: { style: 'circles' } }
+    backfillDefaults(config, mapDefaults, LEGACY_MAP_DEFAULTS)
+    expect(config.legend.style).toBe('circles')
+  })
+
+  it('old config with legend.position: "side" keeps "side" (not replaced with "top")', () => {
+    const config = { legend: { position: 'side' } }
+    backfillDefaults(config, mapDefaults, LEGACY_MAP_DEFAULTS)
+    expect(config.legend.position).toBe('side')
+  })
+
+  it('old config with legend.numberOfItems: 3 keeps 3 (not replaced with 5)', () => {
+    const config = { legend: { numberOfItems: 3 } }
+    backfillDefaults(config, mapDefaults, LEGACY_MAP_DEFAULTS)
+    expect(config.legend.numberOfItems).toBe(3)
+  })
+
+  it('old config with legend.hideBorder: false keeps false (not replaced with true)', () => {
+    const config = { legend: { hideBorder: false } }
+    backfillDefaults(config, mapDefaults, LEGACY_MAP_DEFAULTS)
+    expect(config.legend.hideBorder).toBe(false)
+  })
+
+  it('old config missing one property gets the legacy value, not the new default', () => {
+    const config = { legend: { style: 'circles' } } as any
+    backfillDefaults(config, mapDefaults, LEGACY_MAP_DEFAULTS)
+    expect(config.legend.style).toBe('circles')
+    expect(config.legend.position).toBe('side')
+    expect(config.legend.numberOfItems).toBe(3)
+    expect(config.legend.hideBorder).toBe(false)
+  })
+})

package/helpers/tests/date.test.ts

@@ -0,0 +1,110 @@
+import { describe, it, expect } from 'vitest'
+import { getDateRenderFormat, formatDate } from '../cove/date'
+
+const NBSP = '\u00A0'
+
+describe('getDateRenderFormat', () => {
+  it('replaces space between %b. and %-d with NBSP', () => {
+    expect(getDateRenderFormat('%b. %-d %Y')).toBe(`%b.${NBSP}%-d %Y`)
+  })
+
+  it('replaces space between %b and %-d with NBSP', () => {
+    expect(getDateRenderFormat('%b %-d %Y')).toBe(`%b${NBSP}%-d %Y`)
+  })
+
+  it('replaces space between %B and %-d (full month name)', () => {
+    expect(getDateRenderFormat('%B %-d, %Y')).toBe(`%B${NBSP}%-d, %Y`)
+  })
+
+  it('leaves format unchanged when no month-day space pattern', () => {
+    expect(getDateRenderFormat('%Y-%m-%d')).toBe('%Y-%m-%d')
+  })
+
+  it('does not replace existing NBSP (idempotent)', () => {
+    const alreadyNbsp = `%b.${NBSP}%-d %Y`
+    expect(getDateRenderFormat(alreadyNbsp)).toBe(alreadyNbsp)
+  })
+
+  it('returns undefined for undefined input', () => {
+    expect(getDateRenderFormat(undefined)).toBeUndefined()
+  })
+
+  it('returns empty string for empty string input', () => {
+    expect(getDateRenderFormat('')).toBe('')
+  })
+})
+
+describe('formatDate', () => {
+  it('renders date with NBSP when format has space between month and day', () => {
+    const date = new Date(2025, 0, 15) // Jan 15, 2025
+    const result = formatDate('%b. %-d %Y', date)
+    expect(result).toContain(NBSP)
+    expect(result).toBe(`Jan.${NBSP}15 2025`)
+  })
+
+  it('strips trailing period from "May." when using %b. format', () => {
+    const date = new Date(2025, 4, 15) // May 15, 2025
+    const result = formatDate('%b. %-d, %Y', date)
+    expect(result).not.toContain('May.')
+    expect(result).toContain('May')
+  })
+
+  it('leaves "May" alone when format does not use %b.', () => {
+    const date = new Date(2025, 4, 15) // May 15, 2025
+    const result = formatDate('%b %-d, %Y', date)
+    expect(result).toContain('May')
+    expect(result).not.toContain('May.')
+  })
+
+  it('does not strip period from other months when using %b. format', () => {
+    const date = new Date(2025, 0, 15) // Jan 15, 2025
+    const result = formatDate('%b. %-d, %Y', date)
+    expect(result).toContain('Jan.')
+  })
+
+  describe('locale support', () => {
+    it('formats month names in Spanish when locale is es-MX', () => {
+      const date = new Date(2025, 0, 15) // Jan 15, 2025
+      const result = formatDate('%B %-d, %Y', date, 'es-MX')
+      expect(result).toContain('enero')
+    })
+
+    it('formats abbreviated month names in Spanish when locale is es-MX', () => {
+      const date = new Date(2025, 2, 10) // Mar 10, 2025
+      const result = formatDate('%b %Y', date, 'es-MX')
+      expect(result).toContain('mar')
+    })
+
+    it('formats day names in Spanish when locale is es-MX', () => {
+      const date = new Date(2025, 0, 13) // Monday, Jan 13, 2025
+      const result = formatDate('%A', date, 'es-MX')
+      expect(result).toContain('lunes')
+    })
+
+    it('uses English formatting when locale is en-US', () => {
+      const date = new Date(2025, 0, 15)
+      const result = formatDate('%B %-d, %Y', date, 'en-US')
+      expect(result).toContain('January')
+    })
+
+    it('falls back to default English when locale is unknown', () => {
+      const date = new Date(2025, 0, 15)
+      const result = formatDate('%B %-d, %Y', date, 'xx-XX')
+      expect(result).toContain('January')
+    })
+
+    it('falls back to default English when locale is undefined', () => {
+      const date = new Date(2025, 0, 15)
+      const result = formatDate('%B %-d, %Y', date, undefined)
+      expect(result).toContain('January')
+    })
+
+    it('formats numeric-only patterns identically regardless of locale', () => {
+      const date = new Date(2025, 0, 15)
+      const enResult = formatDate('%Y-%m-%d', date, 'en-US')
+      const esResult = formatDate('%Y-%m-%d', date, 'es-MX')
+      expect(enResult).toBe('2025-01-15')
+      expect(esResult).toBe('2025-01-15')
+    })
+  })
+})

package/helpers/tests/extractDataAndMetadata.test.ts

@@ -0,0 +1,93 @@
+import { extractDataAndMetadata } from '../extractDataAndMetadata'
+import { expect, describe, it } from 'vitest'
+
+describe('extractDataAndMetadata', () => {
+  it('should return plain array input as data with empty metadata', () => {
+    const input = [{ state: 'CA' }, { state: 'TX' }]
+    const result = extractDataAndMetadata(input)
+
+    expect(result.data).toEqual(input)
+    expect(result.dataMetadata).toEqual({})
+  })
+
+  it('should extract data array and metadata siblings from wrapper object', () => {
+    const input = {
+      lastUpdated: 'January 15, 2026',
+      source: 'CDC NREVSS',
+      data: [{ state: 'CA' }, { state: 'TX' }]
+    }
+    const result = extractDataAndMetadata(input)
+
+    expect(result.data).toEqual([{ state: 'CA' }, { state: 'TX' }])
+    expect(result.dataMetadata).toEqual({
+      lastUpdated: 'January 15, 2026',
+      source: 'CDC NREVSS'
+    })
+  })
+
+  it('should handle wrapper with multiple metadata keys', () => {
+    const input = {
+      lastUpdated: '2026-01-15',
+      source: 'CDC',
+      reportingPeriod: 'Q1 2026',
+      data: [{ value: '100' }]
+    }
+    const result = extractDataAndMetadata(input)
+
+    expect(result.dataMetadata).toEqual({
+      lastUpdated: '2026-01-15',
+      source: 'CDC',
+      reportingPeriod: 'Q1 2026'
+    })
+    expect(result.data).toEqual([{ value: '100' }])
+  })
+
+  it('should handle wrapper with empty data array', () => {
+    const input = {
+      lastUpdated: '2026-01-15',
+      source: 'CDC',
+      data: []
+    }
+    const result = extractDataAndMetadata(input)
+
+    expect(result.data).toEqual([])
+    expect(result.dataMetadata).toEqual({
+      lastUpdated: '2026-01-15',
+      source: 'CDC'
+    })
+  })
+
+  it('should return non-array non-object input as data with empty metadata', () => {
+    expect(extractDataAndMetadata('hello')).toEqual({ data: 'hello', dataMetadata: {} })
+    expect(extractDataAndMetadata(42)).toEqual({ data: 42, dataMetadata: {} })
+    expect(extractDataAndMetadata(null)).toEqual({ data: null, dataMetadata: {} })
+    expect(extractDataAndMetadata(undefined)).toEqual({ data: undefined, dataMetadata: {} })
+  })
+
+  it('should return object without data property as data with empty metadata', () => {
+    const input = { foo: 'bar', baz: 123 }
+    const result = extractDataAndMetadata(input)
+
+    expect(result.data).toEqual(input)
+    expect(result.dataMetadata).toEqual({})
+  })
+
+  it('should return object where data is not an array as data with empty metadata', () => {
+    const input = { data: 'string value', source: 'CDC' }
+    const result = extractDataAndMetadata(input)
+
+    expect(result.data).toEqual(input)
+    expect(result.dataMetadata).toEqual({})
+  })
+
+  it('should pass through existing plain-array format unchanged (backward compatibility)', () => {
+    const legacyData = [
+      { state: 'California', population: '39538223' },
+      { state: 'Texas', population: '29145505' }
+    ]
+    const result = extractDataAndMetadata(legacyData)
+
+    expect(result.data).toBe(legacyData)
+    expect(result.dataMetadata).toEqual({})
+  })
+})