@cdc/dashboard 4.25.6 → 4.25.7-2

package/src/helpers/getVizConfig.ts

@@ -1,33 +1,21 @@
 import _ from 'lodash'
 import { MultiDashboardConfig } from '../types/MultiDashboard'
 import DataTransform from '@cdc/core/helpers/DataTransform'
-import { getApplicableFilters } from './getFilteredData'
 import { filterData } from './filterData'
 import { AnyVisualization } from '@cdc/core/types/Visualization'
 
 const transform = new DataTransform()
 
-export const getFootnotesVizConfig = (
-  visualizationConfig: AnyVisualization,
-  rowNumber: number,
-  config: MultiDashboardConfig
-) => {
-  if (!visualizationConfig?.footnotes) return visualizationConfig
-  const data = _.cloneDeep(config.datasets[visualizationConfig.footnotes.dataKey]?.data)
-  const dataColumns = data?.length ? Object.keys(data[0]) : []
-  const filters = (getApplicableFilters(config.dashboard, rowNumber) || []).filter(filter =>
-    dataColumns.includes(filter.columnName)
-  )
+export const getFootnotesVizConfig = (vizConfig: AnyVisualization, config: MultiDashboardConfig) => {
+  if (!vizConfig?.footnotes) return vizConfig
 
-  const newConfig = _.cloneDeep(visualizationConfig)
+  const data = config.datasets[vizConfig.footnotes.dataKey]?.data ?? []
 
-  if (filters.length) {
-    _.set(newConfig, 'footnotes.data', filterData(filters, data))
-  } else {
-    _.set(newConfig, 'footnotes.data', data)
-  }
+  const filters = config?.dashboard?.sharedFilters
+  if (filters.length === 0) return vizConfig
+  vizConfig.footnotes.data = filters.length ? filterData(filters, data) : data
 
-  return newConfig
+  return vizConfig
 }
 
 export const getVizConfig = (
@@ -43,7 +31,7 @@ export const getVizConfig = (
   const visualizationConfig = _.cloneDeep(config.visualizations[visualizationKey])
   const rowData = config.rows[rowNumber]
   if (visualizationConfig.footnotes?.dataKey) {
-    _.set(visualizationConfig, 'footnotes.data', config.datasets[visualizationConfig.footnotes.dataKey]?.data)
+    visualizationConfig.footnotes.data = config.datasets[visualizationConfig.footnotes.dataKey]?.data
   }
   if (rowData?.dataKey) {
     // data configured on the row
@@ -88,18 +76,16 @@ export const getVizConfig = (
 
   if (filteredDataOverride) {
     visualizationConfig.data = filteredDataOverride
-    if (visualizationConfig.formattedData) {
-      visualizationConfig.formattedData = filteredDataOverride
-    }
+    visualizationConfig.formattedData = filteredDataOverride
   }
+
   if (visualizationConfig.footnotes) {
-    const visConfigWithFootnotes = getFootnotesVizConfig(visualizationConfig, rowNumber, config)
+    const visConfigWithFootnotes = getFootnotesVizConfig(visualizationConfig, config)
     if (multiVizColumn && filteredDataOverride) {
       const vizCategory = filteredDataOverride[0][multiVizColumn]
       // the multiViz filtering filtering is applied after the dashboard filters
-
       const categoryFootnote = visConfigWithFootnotes.footnotes.data.filter(d => d[multiVizColumn] === vizCategory)
-      _.set(visConfigWithFootnotes, 'footnotes.data', categoryFootnote)
+      visConfigWithFootnotes.footnotes.data = categoryFootnote
     }
     return visConfigWithFootnotes
   }

package/src/helpers/getVizRowColumnLocator.ts

@@ -1,10 +1,10 @@
-import { ConfigRow } from '../types/ConfigRow'
-
-// returns a dictionary of widget names and their corresponding row and column index
-export const getVizRowColumnLocator = (rows: ConfigRow[]): Record<string, { row: number; column: number }> =>
-  rows.reduce((acc, curr, index) => {
-    curr.columns?.forEach((column, columnIndex) => {
-      if (column.widget !== undefined) acc[column.widget] = { row: index, column: columnIndex }
-    })
-    return acc
-  }, {})
+import { ConfigRow } from '../types/ConfigRow'
+
+// returns a dictionary of widget names and their corresponding row and column index
+export const getVizRowColumnLocator = (rows: ConfigRow[]): Record<string, { row: number; column: number }> =>
+  rows.reduce((acc, curr, index) => {
+    curr.columns?.forEach((column, columnIndex) => {
+      if (column.widget !== undefined) acc[column.widget] = { row: index, column: columnIndex }
+    })
+    return acc
+  }, {})

package/src/helpers/reloadURLHelpers.ts

@@ -1,124 +1,124 @@
-import { gatherQueryParams } from '@cdc/core/helpers/gatherQueryParams'
-import { SharedFilter } from '../types/SharedFilter'
-import { capitalizeSplitAndJoin } from '@cdc/core/helpers/cove/string'
-import { AnyVisualization, Visualization } from '@cdc/core/types/Visualization'
-import _ from 'lodash'
-import { DashboardConfig } from '../types/DashboardConfig'
-import { ConfigRow } from '../types/ConfigRow'
-import { getVizRowColumnLocator } from './getVizRowColumnLocator'
-
-export const isUpdateNeeded = (
-  filters: SharedFilter[],
-  currentQueryParams: Record<string, string>,
-  newQueryParams: Record<string, string>
-): boolean => {
-  let needsUpdate = false
-  filters.find(filter => {
-    if (filter.type === 'urlfilter' && !Array.isArray(filter.active) && filter.filterBy === 'File Name') {
-      needsUpdate = true
-      return true
-    }
-  })
-  Object.keys(newQueryParams).forEach(updatedParam => {
-    if (decodeURIComponent(newQueryParams[updatedParam]) !== currentQueryParams[updatedParam]) {
-      needsUpdate = true
-    }
-  })
-  return needsUpdate
-}
-
-type GetDatasetKeysParams = Pick<DashboardConfig, 'visualizations' | 'datasets' | 'rows'>
-export const getDatasetKeys = ({ visualizations, datasets, rows }: GetDatasetKeysParams): string[] => {
-  const vizDataKeys = Object.values(visualizations).map(viz => viz.dataKey)
-  const rowDataKeys = rows.map(row => row.dataKey)
-  const footnoteDataKeys = Object.values(visualizations)
-    .map(viz => viz.footnotes?.dataKey)
-    .filter(Boolean)
-  // ensure to only load datasets for the specific dashboard tab.
-  const datasetsUsedByDashboard = _.uniq([...vizDataKeys, ...rowDataKeys, ...footnoteDataKeys])
-  return Object.keys(datasets).filter(datasetKey => datasetsUsedByDashboard.includes(datasetKey))
-}
-
-export const getDataURL = (updatedQSParams: Record<string, string | string[]>, dataUrl: URL, newFileName: string) => {
-  const _params = Object.keys(updatedQSParams).flatMap(key => {
-    const value = updatedQSParams[key]
-    if (value === undefined) return []
-    if (typeof value === 'string' && (value as String).match(/undefined/)) return []
-    if (Array.isArray(value)) return value.map(v => ({ key, value: v }))
-    return { key, value }
-  })
-  const baseURL = dataUrl.origin + dataUrl.pathname
-  let dataUrlFinal = `${baseURL}${gatherQueryParams(baseURL, _params)}`
-
-  if (newFileName !== '') {
-    const fileExtension = dataUrl.pathname.split('.').pop()
-    const pathWithoutFilename = dataUrl.pathname.substring(0, dataUrl.pathname.lastIndexOf('/'))
-    dataUrlFinal = `${dataUrl.origin}${pathWithoutFilename}/${newFileName}.${fileExtension}${gatherQueryParams(
-      baseURL,
-      _params
-    )}`
-  }
-  return dataUrlFinal
-}
-
-export const getNewFileName = (newFileName: string, filter: SharedFilter, datasetKey: string) => {
-  const replacements = {
-    'Remove Spaces': '',
-    'Keep Spaces': ' ',
-    'Replace With Underscore': '_'
-  }
-  let fileName = newFileName
-  if (filter.datasetKey === datasetKey) {
-    if (filter.fileName) {
-      // if a file name is found, ie, state_${query}, use that, ie. state_activeFilter.json
-      fileName = capitalizeSplitAndJoin.call(
-        String(filter.fileName),
-        ' ',
-        replacements[filter.whitespaceReplacement ?? 'Keep Spaces']
-      )
-    } else {
-      // if no file name is entered use the default active filter. ie. /activeFilter.json
-      fileName = filter.active as string
-    }
-  }
-
-  if (fileName?.includes('${query}')) {
-    fileName = fileName.replace(
-      '${query}',
-      capitalizeSplitAndJoin.call(
-        String(filter.active),
-        ' ',
-        replacements[filter.whitespaceReplacement ?? 'Keep Spaces']
-      )
-    )
-  }
-
-  return fileName
-}
-
-export const getVisualizationsWithFormattedData = (visualizations: Record<string, Visualization>, newData: Object) => {
-  return Object.keys(visualizations).reduce((acc, vizKey) => {
-    const dataKey = visualizations[vizKey].dataKey
-    if (newData[dataKey]) {
-      acc[vizKey].formattedData = newData[dataKey]
-    }
-    return acc
-  }, _.cloneDeep(visualizations))
-}
-
-export const filterUsedByDataUrl = (
-  filter: SharedFilter,
-  datasetKey: string,
-  visualizations: Record<string, AnyVisualization>,
-  rows: ConfigRow[]
-) => {
-  if (!filter.usedBy || !filter.usedBy.length) return true
-  const vizUsingFilters = filter.usedBy?.map(vizOrRowKey => visualizations[vizOrRowKey] || rows[vizOrRowKey])
-
-  return vizUsingFilters?.some(viz => {
-    const usedByViz = viz?.dataKey === datasetKey
-    // datasetKey might be a key to a dynamic footnotes URL
-    const usedByVizFootnote = viz?.footnotes?.dataKey === datasetKey
-    return usedByViz || usedByVizFootnote
-  })
-}
+import { gatherQueryParams } from '@cdc/core/helpers/gatherQueryParams'
+import { SharedFilter } from '../types/SharedFilter'
+import { capitalizeSplitAndJoin } from '@cdc/core/helpers/cove/string'
+import { AnyVisualization, Visualization } from '@cdc/core/types/Visualization'
+import _ from 'lodash'
+import { DashboardConfig } from '../types/DashboardConfig'
+import { ConfigRow } from '../types/ConfigRow'
+import { getVizRowColumnLocator } from './getVizRowColumnLocator'
+
+export const isUpdateNeeded = (
+  filters: SharedFilter[],
+  currentQueryParams: Record<string, string>,
+  newQueryParams: Record<string, string>
+): boolean => {
+  let needsUpdate = false
+  filters.find(filter => {
+    if (filter.type === 'urlfilter' && !Array.isArray(filter.active) && filter.filterBy === 'File Name') {
+      needsUpdate = true
+      return true
+    }
+  })
+  Object.keys(newQueryParams).forEach(updatedParam => {
+    if (decodeURIComponent(newQueryParams[updatedParam]) !== currentQueryParams[updatedParam]) {
+      needsUpdate = true
+    }
+  })
+  return needsUpdate
+}
+
+type GetDatasetKeysParams = Pick<DashboardConfig, 'visualizations' | 'datasets' | 'rows'>
+export const getDatasetKeys = ({ visualizations, datasets, rows }: GetDatasetKeysParams): string[] => {
+  const vizDataKeys = Object.values(visualizations).map(viz => viz.dataKey)
+  const rowDataKeys = rows.map(row => row.dataKey)
+  const footnoteDataKeys = Object.values(visualizations)
+    .map(viz => viz.footnotes?.dataKey)
+    .filter(Boolean)
+  // ensure to only load datasets for the specific dashboard tab.
+  const datasetsUsedByDashboard = _.uniq([...vizDataKeys, ...rowDataKeys, ...footnoteDataKeys])
+  return Object.keys(datasets).filter(datasetKey => datasetsUsedByDashboard.includes(datasetKey))
+}
+
+export const getDataURL = (updatedQSParams: Record<string, string | string[]>, dataUrl: URL, newFileName: string) => {
+  const _params = Object.keys(updatedQSParams).flatMap(key => {
+    const value = updatedQSParams[key]
+    if (value === undefined) return []
+    if (typeof value === 'string' && (value as String).match(/undefined/)) return []
+    if (Array.isArray(value)) return value.map(v => ({ key, value: v }))
+    return { key, value }
+  })
+  const baseURL = dataUrl.origin + dataUrl.pathname
+  let dataUrlFinal = `${baseURL}${gatherQueryParams(baseURL, _params)}`
+
+  if (newFileName !== '') {
+    const fileExtension = dataUrl.pathname.split('.').pop()
+    const pathWithoutFilename = dataUrl.pathname.substring(0, dataUrl.pathname.lastIndexOf('/'))
+    dataUrlFinal = `${dataUrl.origin}${pathWithoutFilename}/${newFileName}.${fileExtension}${gatherQueryParams(
+      baseURL,
+      _params
+    )}`
+  }
+  return dataUrlFinal
+}
+
+export const getNewFileName = (newFileName: string, filter: SharedFilter, datasetKey: string) => {
+  const replacements = {
+    'Remove Spaces': '',
+    'Keep Spaces': ' ',
+    'Replace With Underscore': '_'
+  }
+  let fileName = newFileName
+  if (filter.datasetKey === datasetKey) {
+    if (filter.fileName) {
+      // if a file name is found, ie, state_${query}, use that, ie. state_activeFilter.json
+      fileName = capitalizeSplitAndJoin.call(
+        String(filter.fileName),
+        ' ',
+        replacements[filter.whitespaceReplacement ?? 'Keep Spaces']
+      )
+    } else {
+      // if no file name is entered use the default active filter. ie. /activeFilter.json
+      fileName = filter.active as string
+    }
+  }
+
+  if (fileName?.includes('${query}')) {
+    fileName = fileName.replace(
+      '${query}',
+      capitalizeSplitAndJoin.call(
+        String(filter.active),
+        ' ',
+        replacements[filter.whitespaceReplacement ?? 'Keep Spaces']
+      )
+    )
+  }
+
+  return fileName
+}
+
+export const getVisualizationsWithFormattedData = (visualizations: Record<string, Visualization>, newData: Object) => {
+  return Object.keys(visualizations).reduce((acc, vizKey) => {
+    const dataKey = visualizations[vizKey].dataKey
+    if (newData[dataKey]) {
+      acc[vizKey].formattedData = newData[dataKey]
+    }
+    return acc
+  }, _.cloneDeep(visualizations))
+}
+
+export const filterUsedByDataUrl = (
+  filter: SharedFilter,
+  datasetKey: string,
+  visualizations: Record<string, AnyVisualization>,
+  rows: ConfigRow[]
+) => {
+  if (!filter.usedBy || !filter.usedBy.length) return true
+  const vizUsingFilters = filter.usedBy?.map(vizOrRowKey => visualizations[vizOrRowKey] || rows[vizOrRowKey])
+
+  return vizUsingFilters?.some(viz => {
+    const usedByViz = viz?.dataKey === datasetKey
+    // datasetKey might be a key to a dynamic footnotes URL
+    const usedByVizFootnote = viz?.footnotes?.dataKey === datasetKey
+    return usedByViz || usedByVizFootnote
+  })
+}

package/src/store/dashboard.actions.ts

@@ -1,62 +1,61 @@
-import type { DashboardConfig as Config } from '../types/DashboardConfig'
-import { type Action } from '@cdc/core/types/Action'
-import { Tab } from '../types/Tab'
-import { ConfigRow } from '../types/ConfigRow'
-import { AnyVisualization } from '@cdc/core/types/Visualization'
-import Footnotes from '@cdc/core/types/Footnotes'
-import { SharedFilter } from '../types/SharedFilter'
-
-type ADD_VISUALIZATION = Action<'ADD_VISUALIZATION', { rowIdx: number; colIdx: number; newViz: AnyVisualization }>
-type APPLY_CONFIG = Action<'APPLY_CONFIG', [Config, Object?]>
-type DELETE_WIDGET = Action<'DELETE_WIDGET', { uid: string }>
-type MOVE_VISUALIZATION = Action<
-  'MOVE_VISUALIZATION',
-  { rowIdx: number; colIdx: number; widget: AnyVisualization & { rowIdx: number; colIdx: number } }
->
-type SET_CONFIG = Action<'SET_CONFIG', Partial<Config> & { activeDashboard?: number }>
-type UPDATE_CONFIG = Action<'UPDATE_CONFIG', [Config, Object?]>
-type SET_DATA = Action<'SET_DATA', Record<string, any[]>>
-type SET_LOADING = Action<'SET_LOADING', boolean>
-type SET_PREVIEW = Action<'SET_PREVIEW', boolean>
-type SET_FILTERED_DATA = Action<'SET_FILTERED_DATA', Object>
-type SET_SHARED_FILTERS = Action<'SET_SHARED_FILTERS', SharedFilter[]>
-type SET_TAB_SELECTED = Action<'SET_TAB_SELECTED', Tab>
-type RENAME_DASHBOARD_TAB = Action<'RENAME_DASHBOARD_TAB', { current: string; new: string }>
-type INITIALIZE_MULTIDASHBOARDS = Action<'INITIALIZE_MULTIDASHBOARDS', undefined>
-type REMOVE_MULTIDASHBOARD_AT_INDEX = Action<'REMOVE_MULTIDASHBOARD_AT_INDEX', number>
-type REORDER_MULTIDASHBOARDS = Action<'REORDER_MULTIDASHBOARDS', { currentIndex: number; newIndex: number }>
-type ADD_NEW_DASHBOARD = Action<'ADD_NEW_DASHBOARD', undefined>
-type SAVE_CURRENT_CHANGES = Action<'SAVE_CURRENT_CHANGES', undefined>
-type SWITCH_CONFIG = Action<'SWITCH_CONFIG', number>
-type TOGGLE_ROW = Action<'TOGGLE_ROW', { rowIndex: number; colIndex: number }>
-type RESET_VISUALIZATION = Action<'RESET_VISUALIZATION', { vizKey: string }>
-type UPDATE_VISUALIZATION = Action<'UPDATE_VISUALIZATION', { vizKey: string; configureData: Partial<AnyVisualization> }>
-type UPDATE_ROW = Action<'UPDATE_ROW', { rowIndex: number; rowData: Partial<ConfigRow> }>
-type UPDATE_TOGGLE_NAME = Action<'UPDATE_TOGGLE_NAME', { rowIndex: number; columnIndex: number; toggleName: string }>
-
-type DashboardActions =
-  | ADD_VISUALIZATION
-  | APPLY_CONFIG
-  | ADD_NEW_DASHBOARD
-  | DELETE_WIDGET
-  | MOVE_VISUALIZATION
-  | SET_CONFIG
-  | UPDATE_CONFIG
-  | REMOVE_MULTIDASHBOARD_AT_INDEX
-  | RENAME_DASHBOARD_TAB
-  | REORDER_MULTIDASHBOARDS
-  | SAVE_CURRENT_CHANGES
-  | SET_DATA
-  | SET_LOADING
-  | SET_PREVIEW
-  | SET_FILTERED_DATA
-  | SET_SHARED_FILTERS
-  | SET_TAB_SELECTED
-  | SWITCH_CONFIG
-  | INITIALIZE_MULTIDASHBOARDS
-  | TOGGLE_ROW
-  | RESET_VISUALIZATION
-  | UPDATE_VISUALIZATION
-  | UPDATE_ROW
-  | UPDATE_TOGGLE_NAME
-export default DashboardActions
+import type { DashboardConfig as Config } from '../types/DashboardConfig'
+import { type Action } from '@cdc/core/types/Action'
+import { Tab } from '../types/Tab'
+import { ConfigRow } from '../types/ConfigRow'
+import { AnyVisualization } from '@cdc/core/types/Visualization'
+import { SharedFilter } from '../types/SharedFilter'
+
+type ADD_VISUALIZATION = Action<'ADD_VISUALIZATION', { rowIdx: number; colIdx: number; newViz: AnyVisualization }>
+type APPLY_CONFIG = Action<'APPLY_CONFIG', [Config, Object?]>
+type DELETE_WIDGET = Action<'DELETE_WIDGET', { uid: string }>
+type MOVE_VISUALIZATION = Action<
+  'MOVE_VISUALIZATION',
+  { rowIdx: number; colIdx: number; widget: AnyVisualization & { rowIdx: number; colIdx: number } }
+>
+type SET_CONFIG = Action<'SET_CONFIG', Partial<Config> & { activeDashboard?: number }>
+type UPDATE_CONFIG = Action<'UPDATE_CONFIG', [Config, Object?]>
+type SET_DATA = Action<'SET_DATA', Record<string, any[]>>
+type SET_LOADING = Action<'SET_LOADING', boolean>
+type SET_PREVIEW = Action<'SET_PREVIEW', boolean>
+type SET_FILTERED_DATA = Action<'SET_FILTERED_DATA', Object>
+type SET_SHARED_FILTERS = Action<'SET_SHARED_FILTERS', SharedFilter[]>
+type SET_TAB_SELECTED = Action<'SET_TAB_SELECTED', Tab>
+type RENAME_DASHBOARD_TAB = Action<'RENAME_DASHBOARD_TAB', { current: string; new: string }>
+type INITIALIZE_MULTIDASHBOARDS = Action<'INITIALIZE_MULTIDASHBOARDS', undefined>
+type REMOVE_MULTIDASHBOARD_AT_INDEX = Action<'REMOVE_MULTIDASHBOARD_AT_INDEX', number>
+type REORDER_MULTIDASHBOARDS = Action<'REORDER_MULTIDASHBOARDS', { currentIndex: number; newIndex: number }>
+type ADD_NEW_DASHBOARD = Action<'ADD_NEW_DASHBOARD', undefined>
+type SAVE_CURRENT_CHANGES = Action<'SAVE_CURRENT_CHANGES', undefined>
+type SWITCH_CONFIG = Action<'SWITCH_CONFIG', number>
+type TOGGLE_ROW = Action<'TOGGLE_ROW', { rowIndex: number; colIndex: number }>
+type RESET_VISUALIZATION = Action<'RESET_VISUALIZATION', { vizKey: string }>
+type UPDATE_VISUALIZATION = Action<'UPDATE_VISUALIZATION', { vizKey: string; configureData: Partial<AnyVisualization> }>
+type UPDATE_ROW = Action<'UPDATE_ROW', { rowIndex: number; rowData: Partial<ConfigRow> }>
+type UPDATE_TOGGLE_NAME = Action<'UPDATE_TOGGLE_NAME', { rowIndex: number; columnIndex: number; toggleName: string }>
+
+type DashboardActions =
+  | ADD_VISUALIZATION
+  | APPLY_CONFIG
+  | ADD_NEW_DASHBOARD
+  | DELETE_WIDGET
+  | MOVE_VISUALIZATION
+  | SET_CONFIG
+  | UPDATE_CONFIG
+  | REMOVE_MULTIDASHBOARD_AT_INDEX
+  | RENAME_DASHBOARD_TAB
+  | REORDER_MULTIDASHBOARDS
+  | SAVE_CURRENT_CHANGES
+  | SET_DATA
+  | SET_LOADING
+  | SET_PREVIEW
+  | SET_FILTERED_DATA
+  | SET_SHARED_FILTERS
+  | SET_TAB_SELECTED
+  | SWITCH_CONFIG
+  | INITIALIZE_MULTIDASHBOARDS
+  | TOGGLE_ROW
+  | RESET_VISUALIZATION
+  | UPDATE_VISUALIZATION
+  | UPDATE_ROW
+  | UPDATE_TOGGLE_NAME
+export default DashboardActions