@cdc/editor 4.26.2 → 4.26.4

package/package.json

@@ -1,17 +1,17 @@
 {
   "name": "@cdc/editor",
-  "version": "4.26.2",
+  "version": "4.26.4",
   "description": "React component for generating a new component entry",
   "license": "Apache-2.0",
   "bugs": "https://github.com/CDCgov/cdc-open-viz/issues",
   "dependencies": {
-    "@cdc/chart": "^4.26.2",
-    "@cdc/core": "^4.26.2",
-    "@cdc/dashboard": "^4.26.2",
-    "@cdc/data-bite": "^4.26.2",
-    "@cdc/map": "^4.26.2",
-    "@cdc/markup-include": "^4.26.2",
-    "@cdc/waffle-chart": "^4.26.2",
+    "@cdc/chart": "^4.26.4",
+    "@cdc/core": "^4.26.4",
+    "@cdc/dashboard": "^4.26.4",
+    "@cdc/data-bite": "^4.26.4",
+    "@cdc/map": "^4.26.4",
+    "@cdc/markup-include": "^4.26.4",
+    "@cdc/waffle-chart": "^4.26.4",
     "axios": "^1.13.2",
     "d3": "^7.9.0",
     "react-dropzone": "^14.3.8",
@@ -23,7 +23,7 @@
     "vite-plugin-css-injected-by-js": "^2.4.0",
     "vite-plugin-svgr": "^4.2.0"
   },
-  "gitHead": "be3413e8e1149abf94225108f86a7910f56e0616",
+  "gitHead": "6097de1ff814001880d9ac64bd66becdc092d63c",
   "main": "dist/cdceditor",
   "moduleName": "CdcEditor",
   "peerDependencies": {

package/src/CdcEditor.tsx

@@ -19,7 +19,6 @@ import { legacyConfigSupport } from './helpers/legacyConfigSupport'
 
 import './scss/main.scss'
 import editorReducer, { EditorState } from '@cdc/core/contexts/editor.reducer'
-import _ from 'lodash'
 import { cloneConfig } from '@cdc/core/helpers/cloneConfig'
 import { WCMSProps } from '@cdc/core/types/WCMSProps'
 import { devToolsStore } from '@cdc/core/helpers/withDevTools'
@@ -73,7 +72,7 @@ const CdcEditor: React.FC<WCMSProps> = ({ config: configObj, hostname, container
   }, [])
 
   useEffect(() => {
-    let strippedConfig = stripConfig(state.config)
+    let strippedConfig = stripConfig(state.config, true)
 
     const parsedData = JSON.stringify(strippedConfig)
     // Emit the data in a regular JS event so it can be consumed by anything.
@@ -99,7 +98,7 @@ const CdcEditor: React.FC<WCMSProps> = ({ config: configObj, hostname, container
     <GlobalContextProvider>
       <ConfigContext.Provider value={{ ...state, setTempConfig: setTempConfigAndUpdate }}>
         <EditorDispatchContext.Provider value={dispatch}>
-          <div className={`cdc-open-viz-module cdc-editor ${state.currentViewport}`} ref={outerContainerRef}>
+          <div className={`cove-visualization cdc-editor ${state.currentViewport}`} ref={outerContainerRef}>
             <Tabs className='top-level'>
               <TabPane title='1. Choose Visualization Type' className='choose-type'>
                 <ChooseTab />

package/src/_stories/Editor.stories.tsx

@@ -1,9 +1,29 @@
 import { Meta, StoryObj } from '@storybook/react-vite'
 import CdcEditor from '../CdcEditor'
-import { within, userEvent } from 'storybook/test'
+import { within, userEvent, expect } from 'storybook/test'
+import ChartEditorConfig from '../../../chart/src/_stories/_mock/editor-tests/bar-chart-editor-test.json'
+import MapConfig from '../../../map/src/_stories/_mock/default-patterns.json'
+import DashboardConfig from '../../../dashboard/src/_stories/_mock/dashboard_no_filter.json'
+import DataTableConfig from '../../../data-table/examples/data-table-example.json'
 
-const sleep = ms => {
-  return new Promise(r => setTimeout(r, ms))
+const loadConfigFromTextArea = async (canvasElement, config) => {
+  const user = userEvent.setup()
+  const textArea = canvasElement.querySelector('#pasteConfig') as HTMLTextAreaElement
+  const loadButton = canvasElement.querySelector('#load-data') as HTMLButtonElement
+
+  expect(textArea).toBeTruthy()
+  expect(loadButton).toBeTruthy()
+
+  await user.click(textArea)
+  await user.clear(textArea)
+  await user.paste(JSON.stringify(config))
+  await user.click(loadButton)
+}
+
+const assertImportDataTabAccessible = async canvas => {
+  const user = userEvent.setup()
+  await user.click(canvas.getByText('2. Import Data'))
+  await expect(canvas.findByText('Data Preview')).resolves.toBeTruthy()
 }
 
 const meta: Meta<typeof CdcEditor> = {
@@ -26,10 +46,157 @@ export const PreviewTableTests: Story = {
   play: async ({ canvasElement }) => {
     const canvas = within(canvasElement)
     const user = userEvent.setup()
-    await sleep(1000)
-    const mapButton = canvas.getByText('United States (State- or County-Level)')
+
+    const mapButton = await canvas.findByRole('button', { name: 'United States (State- or County-Level)' })
     await user.click(mapButton)
-    const sampleData = canvas.getByText('United States: County Sample Data')
+
+    await user.click(canvas.getByText('2. Import Data'))
+
+    const sampleData = await canvas.findByText('United States: County Sample Data')
     await user.click(sampleData)
+
+    await expect(canvas.findByText('Data Preview')).resolves.toBeTruthy()
+  }
+}
+
+export const LoadChartJsonConfig: Story = {
+  args: {
+    config: {}
+  },
+  play: async ({ canvasElement }) => {
+    const canvas = within(canvasElement)
+    await loadConfigFromTextArea(canvasElement, ChartEditorConfig)
+    await assertImportDataTabAccessible(canvas)
+  }
+}
+
+export const LoadMapJsonConfig: Story = {
+  args: {
+    config: {}
+  },
+  play: async ({ canvasElement }) => {
+    const canvas = within(canvasElement)
+    await loadConfigFromTextArea(canvasElement, MapConfig)
+    await assertImportDataTabAccessible(canvas)
+  }
+}
+
+export const LoadDashboardJsonConfig: Story = {
+  args: {
+    config: {}
+  },
+  play: async ({ canvasElement }) => {
+    const canvas = within(canvasElement)
+    await loadConfigFromTextArea(canvasElement, DashboardConfig)
+    await assertImportDataTabAccessible(canvas)
+  }
+}
+
+export const LoadDataTableJsonConfig: Story = {
+  args: {
+    config: {}
+  },
+  play: async ({ canvasElement }) => {
+    const canvas = within(canvasElement)
+    await loadConfigFromTextArea(canvasElement, DataTableConfig)
+    await assertImportDataTabAccessible(canvas)
+  }
+}
+
+export const DownloadDashboardDatasetCSV: Story = {
+  args: { config: {} },
+  play: async ({ canvasElement }) => {
+    const canvas = within(canvasElement)
+    const user = userEvent.setup()
+
+    await loadConfigFromTextArea(canvasElement, DashboardConfig)
+    await user.click(canvas.getByText('2. Import Data'))
+    await expect(canvas.findByText('Data Sources')).resolves.toBeTruthy()
+
+    const originalCreateObjectURL = URL.createObjectURL
+    let capturedBlob: Blob | null = null
+    URL.createObjectURL = (blob: Blob) => {
+      capturedBlob = blob
+      return 'blob:test-mock'
+    }
+
+    try {
+      const downloadBtn = await canvas.findByRole('button', { name: 'Download' })
+      await user.click(downloadBtn)
+
+      expect(capturedBlob).toBeTruthy()
+      const text = await capturedBlob!.text()
+      expect(text).toContain('Location')
+      expect(text).toContain('Rate')
+    } finally {
+      URL.createObjectURL = originalCreateObjectURL
+    }
+  }
+}
+
+export const DownloadSingleVizCSV: Story = {
+  args: { config: {} },
+  play: async ({ canvasElement }) => {
+    const canvas = within(canvasElement)
+    const user = userEvent.setup()
+
+    await loadConfigFromTextArea(canvasElement, ChartEditorConfig)
+    await user.click(canvas.getByText('2. Import Data'))
+    await expect(canvas.findByText('Data Preview')).resolves.toBeTruthy()
+
+    const originalCreateObjectURL = URL.createObjectURL
+    let capturedBlob: Blob | null = null
+    URL.createObjectURL = (blob: Blob) => {
+      capturedBlob = blob
+      return 'blob:test-mock'
+    }
+
+    try {
+      const downloadBtn = await canvas.findByRole('button', { name: 'Download CSV' })
+      await user.click(downloadBtn)
+
+      expect(capturedBlob).toBeTruthy()
+      const text = await capturedBlob!.text()
+      expect(text).toContain('Year')
+      expect(text).toContain('Category')
+    } finally {
+      URL.createObjectURL = originalCreateObjectURL
+    }
+  }
+}
+
+export const InvalidJsonShowsValidationAlert: Story = {
+  args: {
+    config: {}
+  },
+  play: async ({ canvasElement }) => {
+    const user = userEvent.setup()
+    const textArea = canvasElement.querySelector('#pasteConfig') as HTMLTextAreaElement
+    const loadButton = canvasElement.querySelector('#load-data') as HTMLButtonElement
+
+    expect(textArea).toBeTruthy()
+    expect(loadButton).toBeTruthy()
+
+    const originalAlert = window.alert
+    const originalOnError = window.onerror
+    let alertText = ''
+
+    window.alert = message => {
+      alertText = String(message)
+    }
+
+    window.onerror = () => true
+
+    try {
+      await user.click(textArea)
+      await user.clear(textArea)
+      await user.paste('{"broken": true, }')
+      await user.click(loadButton)
+
+      await expect(alertText).toBe('The JSON that was entered is invalid.')
+    } finally {
+      window.alert = originalAlert
+      window.onerror = originalOnError
+    }
   }
 }

package/src/components/ChooseTab.test.tsx

@@ -0,0 +1,36 @@
+import React from 'react'
+import { render, waitFor } from '@testing-library/react'
+
+import ConfigContext, { EditorDispatchContext } from '@cdc/core/contexts/EditorContext'
+import ChooseTab from './ChooseTab'
+
+describe('ChooseTab', () => {
+  it('dispatches EDITOR_SAVE once when tempConfig is present', async () => {
+    const dispatch = vi.fn()
+    const tempConfig = { type: 'chart', data: [{ x: 'A', y: 1 }] }
+
+    render(
+      <ConfigContext.Provider
+        value={
+          {
+            config: { type: 'chart' },
+            tempConfig,
+            errors: [],
+            currentViewport: 'lg',
+            globalActive: 0,
+            setTempConfig: vi.fn()
+          } as any
+        }
+      >
+        <EditorDispatchContext.Provider value={dispatch}>
+          <ChooseTab />
+        </EditorDispatchContext.Provider>
+      </ConfigContext.Provider>
+    )
+
+    await waitFor(() => {
+      expect(dispatch).toHaveBeenCalledTimes(1)
+      expect(dispatch).toHaveBeenCalledWith({ type: 'EDITOR_SAVE', payload: tempConfig })
+    })
+  })
+})

package/src/components/ChooseTab.tsx

@@ -1,8 +1,9 @@
-import React, { useContext, useState } from 'react'
+import React, { useContext, useEffect, useState } from 'react'
 import '../scss/choose-vis-tab.scss'
 
 import ConfigContext, { EditorDispatchContext } from '@cdc/core/contexts/EditorContext'
 import Tooltip from '@cdc/core/components/ui/Tooltip'
+import Button from '@cdc/core/components/elements/Button'
 
 import AlabamaGraphic from '@cdc/core/assets/icon-map-alabama.svg'
 import AreaChartIcon from '@cdc/core/assets/icon-area-chart.svg'
@@ -51,6 +52,23 @@ interface ButtonProps {
   orientation?: string | null
 }
 
+interface VizButtonProps extends ButtonProps {
+  activeVizButtonID?: number
+  onConfigure: (props: Record<string, unknown>) => void
+}
+
+const VizButton: React.FC<VizButtonProps> = ({ activeVizButtonID, onConfigure, ...buttonProps }) => {
+  const { label, icon, id } = buttonProps
+  const isActive = id === activeVizButtonID || 0
+
+  return (
+    <button className={isActive ? 'active' : ''} onClick={() => onConfigure(buttonProps)} aria-label={label}>
+      {icon}
+      <span className='mt-1'>{label}</span>
+    </button>
+  )
+}
+
 const ChooseTab: React.FC = (): JSX.Element => {
   const { config, tempConfig } = useContext(ConfigContext)
 
@@ -59,6 +77,12 @@ const ChooseTab: React.FC = (): JSX.Element => {
   const dispatch = useContext(EditorDispatchContext)
   const rowLabels = ['General', , 'Charts', 'Maps']
 
+  useEffect(() => {
+    if (tempConfig) {
+      dispatch({ type: 'EDITOR_SAVE', payload: tempConfig })
+    }
+  }, [dispatch, tempConfig])
+
   const handleUpload = e => {
     const file = e.target.files[0]
     const reader = new FileReader()
@@ -75,12 +99,15 @@ const ChooseTab: React.FC = (): JSX.Element => {
       newConfig = JSON.parse(text)
     } catch (e) {
       alert('The JSON that was entered is invalid.')
-      throw new Error()
+      return
     }
 
     const isVega = isVegaConfig(newConfig)
     if (isVega) {
       newConfig = importVegaConfig(newConfig)
+      if (!newConfig) {
+        return
+      }
     }
 
     dispatch({ type: 'EDITOR_SET_CONFIG', payload: newConfig })
@@ -112,7 +139,7 @@ const ChooseTab: React.FC = (): JSX.Element => {
 
     const errorText = vegaErrors.join('\n\n')
     alert(errorText)
-    throw new Error(errorText)
+    return null
   }
 
   const generateNewConfig = props => {
@@ -174,25 +201,6 @@ const ChooseTab: React.FC = (): JSX.Element => {
     dispatch({ type: 'EDITOR_SET_GLOBALACTIVE', payload: 1 })
   }
 
-  const VizButton: React.FC<ButtonProps> = props => {
-    const { label, icon, id } = props
-    const isActive = id === config?.activeVizButtonID || 0
-    const handleClick = () => {
-      configureTabs(props)
-    }
-
-    if (tempConfig) {
-      dispatch({ type: 'EDITOR_SAVE', payload: tempConfig })
-    }
-
-    return (
-      <button className={isActive ? 'active' : ''} onClick={handleClick} aria-label={label}>
-        {icon}
-        <span className='mt-1'>{label}</span>
-      </button>
-    )
-  }
-
   return (
     <div className='choose-vis'>
       <a
@@ -221,7 +229,11 @@ const ChooseTab: React.FC = (): JSX.Element => {
                   <li key={`${label}-button-${buttonIndex}`}>
                     <Tooltip position='right'>
                       <Tooltip.Target>
-                        <VizButton {...button} />
+                        <VizButton
+                          {...button}
+                          activeVizButtonID={config?.activeVizButtonID}
+                          onConfigure={configureTabs}
+                        />
                       </Tooltip.Target>
                       <Tooltip.Content>{button.content}</Tooltip.Content>
                     </Tooltip>
@@ -263,15 +275,16 @@ const ChooseTab: React.FC = (): JSX.Element => {
             placeholder='{ }'
             value={pastedConfig}
           />
-          <button
-            className='btn btn-primary px-4 ms-2'
+          <Button
+            variant='primary'
+            className='px-4 ms-2'
             type='submit'
             id='load-data'
             disabled={!pastedConfig}
             onClick={() => importConfig(pastedConfig)}
           >
             Load
-          </button>
+          </Button>
         </div>
       </div>
     </div>