@cdc/markup-include 4.23.10-alpha → 4.23.11

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cdc/markup-include",
-  "version": "4.23.10-alpha",
+  "version": "4.23.11",
   "description": "React component for displaying HTML content from an outside link",
   "moduleName": "CdcMarkupInclude",
   "main": "dist/cdcmarkupinclude",
@@ -26,8 +26,8 @@
   "license": "Apache-2.0",
   "homepage": "https://github.com/CDCgov/cdc-open-viz#readme",
   "dependencies": {
-    "@cdc/core": "^4.23.10-alpha",
-    "axios": "^0.26.1",
+    "@cdc/core": "^4.23.11",
+    "axios": "^1.6.0",
     "chroma": "0.0.1",
     "chroma-js": "^2.1.0",
     "html-react-parser": "^3.0.8",
@@ -38,5 +38,5 @@
     "react": "^18.2.0",
     "react-dom": "^18.2.0"
   },
-  "gitHead": "47278535fb20bb4e6b3320f8075051bedc5bca8e"
+  "gitHead": "ecad213667a3cb96c921eaddba43a31c84caaa08"
 }

package/src/{CdcMarkupInclude.jsx → CdcMarkupInclude.tsx}

@@ -1,32 +1,44 @@
-import React, { useEffect, useCallback, useState, useRef } from 'react'
-import axios from 'axios'
-import parse from 'html-react-parser'
-import { Markup } from 'interweave'
+import { useEffect, useCallback, useRef, useReducer } from 'react'
 
-import ErrorBoundary from '@cdc/core/components/ErrorBoundary'
-import Loading from '@cdc/core/components/Loading'
+// external
+import { Markup } from 'interweave'
+import axios from 'axios'
 
+// cdc
+import { Config } from './types/Config'
+import { publish } from '@cdc/core/helpers/events'
 import ConfigContext from './ConfigContext'
-import EditorPanel from './components/EditorPanel'
+import coveUpdateWorker from '@cdc/core/helpers/coveUpdateWorker'
 import defaults from './data/initial-state'
+import EditorPanel from './components/EditorPanel'
 
+import ErrorBoundary from '@cdc/core/components/ErrorBoundary'
+import Loading from '@cdc/core/components/Loading'
+import useDataVizClasses from '@cdc/core/helpers/useDataVizClasses'
+import markupIncludeReducer from './store/mi.reducer'
+
+// styles
 import './scss/main.scss'
 
-import { publish } from '@cdc/core/helpers/events'
+type CdcMarkupIncludeProps = {
+  config: Config
+  configUrl: string
+  isDashboard: boolean
+  isEditor: boolean
+  setConfig: any
+}
 
-import useDataVizClasses from '@cdc/core/helpers/useDataVizClasses'
-import coveUpdateWorker from '@cdc/core/helpers/coveUpdateWorker'
+import Title from '@cdc/core/components/ui/Title'
+
+const CdcMarkupInclude = (props: CdcMarkupIncludeProps) => {
+  const { configUrl, config: configObj, isDashboard = false, isEditor = false, setConfig: setParentConfig } = props
+  const initialState = { config: configObj ?? defaults, loading: true, urlMarkup: '', markupError: null, errorMessage: null, coveLoadedHasRan: false }
 
-const CdcMarkupInclude = ({ configUrl, config: configObj, isDashboard = false, isEditor = false, setConfig: setParentConfig }) => {
-  // Default States
-  const [config, setConfig] = useState({ ...defaults })
-  const [loading, setLoading] = useState(true)
+  const [state, dispatch] = useReducer(markupIncludeReducer, initialState)
+
+  const { config, loading, urlMarkup, markupError, errorMessage, coveLoadedHasRan } = state
 
   // Custom States
-  const [urlMarkup, setUrlMarkup] = useState('')
-  const [markupError, setMarkupError] = useState(null)
-  const [errorMessage, setErrorMessage] = useState(null)
-  const [coveLoadedHasRan, setCoveLoadedHasRan] = useState(false)
   const container = useRef()
 
   const { innerContainerClasses, contentClasses } = useDataVizClasses(config)
@@ -45,7 +57,7 @@ const CdcMarkupInclude = ({ configUrl, config: configObj, isDashboard = false, i
     newConfig.runtime.uniqueId = Date.now()
 
     newConfig.runtime.editorErrorMessage = ''
-    setConfig(newConfig)
+    dispatch({ type: 'SET_CONFIG', payload: newConfig })
   }
 
   const loadConfig = useCallback(async () => {
@@ -61,7 +73,7 @@ const CdcMarkupInclude = ({ configUrl, config: configObj, isDashboard = false, i
     const processedConfig = { ...(await coveUpdateWorker(response)) }
 
     updateConfig({ ...defaults, ...processedConfig })
-    setLoading(false)
+    dispatch({ type: 'SET_LOADING', payload: false })
   }, [])
 
   // Custom Functions
@@ -82,41 +94,42 @@ const CdcMarkupInclude = ({ configUrl, config: configObj, isDashboard = false, i
       }
 
       message += errorList[errorCode]
-      setErrorMessage(message)
+      dispatch({ type: 'SET_ERROR_MESSAGE', payload: message })
     } else {
-      setErrorMessage(null)
+      dispatch({ type: 'SET_ERROR_MESSAGE', payload: null })
     }
   }, [markupError])
 
   const loadConfigMarkupData = useCallback(async () => {
-    setMarkupError(null)
+    dispatch({ type: 'SET_MARKUP_ERROR', payload: null })
 
     if (config.srcUrl) {
       if (config.srcUrl === '#example') {
-        setUrlMarkup(
+        let payload =
           '<!doctype html><html lang="en"> <head> <meta charset="UTF-8"> <meta name="viewport" content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0"> <meta http-equiv="X-UA-Compatible" content="ie=edge"> <title>Document</title> </head> <body> <h1>Header</h1> <p>Far far away, behind the word mountains, far from the countries Vokalia and Consonantia, there live the blind texts. Separated they live in Bookmarksgrove right at the coast of the Semantics, a large language ocean. A small river named Duden flows by their place and supplies it with the necessary regelialia. It is a paradisematic country, in which roasted parts of sentences fly into your mouth.</p> <br> <p>Even the all-powerful Pointing has no control about the blind texts it is an almost unorthographic life One day however a small line of blind text by the name of Lorem Ipsum decided to leave for the far World of Grammar. The Big Oxmox advised her not to do so, because there were thousands of bad Commas, wild Question Marks and devious Semikoli, but the Little Blind Text didn’t listen. </p><br><p>She packed her seven versalia, put her initial into the belt and made herself on the way. When she reached the first hills of the Italic Mountains, she had a last view back on the skyline of her hometown Bookmarksgrove, the headline of Alphabet Village and the subline of her own road, the Line Lane. Pityful a rethoric question ran over her cheek.</p></body></html>'
-        )
+
+        dispatch({ type: 'SET_URL_MARKUP', payload })
       } else {
         try {
           await axios.get(config.srcUrl).then(res => {
             if (res.data) {
-              setUrlMarkup(res.data)
+              dispatch({ type: 'SET_URL_MARKUP', payload: res.data })
             }
           })
         } catch (err) {
           if (err.response) {
             // Response with error
-            setMarkupError(err.response.status)
+            dispatch({ type: 'SET_MARKUP_ERROR', payload: err.response.status })
           } else if (err.request) {
             // No response received
-            setMarkupError(200)
+            dispatch({ type: 'SET_MARKUP_ERROR', payload: 200 })
           }
 
-          setUrlMarkup('')
+          dispatch({ type: 'SET_URL_MARKUP', payload: '' })
         }
       }
     } else {
-      setUrlMarkup('')
+      dispatch({ type: 'SET_URL_MARKUP', payload: '' })
     }
   }, [config.srcUrl])
 
@@ -144,7 +157,7 @@ const CdcMarkupInclude = ({ configUrl, config: configObj, isDashboard = false, i
   useEffect(() => {
     if (config && !coveLoadedHasRan && container) {
       publish('cove_loaded', { config: config })
-      setCoveLoadedHasRan(true)
+      dispatch({ type: 'SET_COVE_LOADED_HAS_RAN', payload: true })
     }
   }, [config, container])
 
@@ -165,11 +178,7 @@ const CdcMarkupInclude = ({ configUrl, config: configObj, isDashboard = false, i
   if (loading === false) {
     let body = (
       <div className={bodyClasses.join(' ')} ref={container}>
-        {title && (
-          <header className={`cove-component__header ${config.theme}`} aria-hidden='true'>
-            {parse(title)} {isDashboard}
-          </header>
-        )}
+        <Title title={title} isDashboard={isDashboard} classes={[`${config.theme}`, 'mb-0']} />
         <div className={`cove-component__content ${contentClasses.join(' ')}`}>
           <div className={`${innerContainerClasses.join(' ')}`}>
             <div className='cove-component__content-wrap'>

package/src/_stories/MarkupInclude.stories.tsx

@@ -0,0 +1,19 @@
+import type { Meta, StoryObj } from '@storybook/react'
+import ExampleConfig_1 from './../data/initial-state'
+import CdcMarkupInclude from '../CdcMarkupInclude'
+import { Config } from '../types/Config'
+
+const meta: Meta<typeof CdcMarkupInclude> = {
+  title: 'Components/Templates/Markup Include',
+  component: CdcMarkupInclude
+}
+
+type Story = StoryObj<typeof CdcMarkupInclude>
+
+export const Initial_State: Story = {
+  args: {
+    config: ExampleConfig_1 as unknown as Config
+  }
+}
+
+export default meta

package/src/scss/main.scss

@@ -9,10 +9,6 @@
     margin-bottom: 24px;
   }
 
-  .cove-component__header {
-    font-size: unset;
-  }
-
   .cove-component__content {
     background-color: #f2f2f2;
     font-size: 14px;

package/src/store/mi.actions.ts

@@ -0,0 +1,21 @@
+import type { Config } from '../types/Config'
+
+type Action<T, P> = { type: T; payload: P }
+
+type SET_CONFIG = Action<'SET_CONFIG', Config>
+type SET_LOADING = Action<'SET_LOADING', boolean>
+type SET_URL_MARKUP = Action<'SET_URL_MARKUP', string>
+type SET_MARKUP_ERROR = Action<'SET_MARKUP_ERROR', any>
+type SET_ERROR_MESSAGE = Action<'SET_ERROR_MESSAGE', any>
+type SET_COVE_LOADED_HAS_RAN = Action<'SET_COVE_LOADED_HAS_RAN', boolean>
+
+// prettier-ignore
+type MarkupIncludeActions =
+  | SET_CONFIG
+  | SET_LOADING
+  | SET_URL_MARKUP
+  | SET_MARKUP_ERROR
+  | SET_ERROR_MESSAGE
+  | SET_COVE_LOADED_HAS_RAN
+
+export default MarkupIncludeActions

package/src/store/mi.reducer.ts

@@ -0,0 +1,36 @@
+import { Config } from '../types/Config'
+import MarkupIncludeActions from './mi.actions'
+
+export type MarkupIncludeState = {
+  config?: Config
+  loading: boolean
+  urlMarkup: string
+  markupError: any
+  errorMessage: any
+  coveLoadedHasRan: boolean
+}
+
+const reducer = (state: MarkupIncludeState, action: MarkupIncludeActions): MarkupIncludeState => {
+  switch (action.type) {
+    case 'SET_CONFIG': {
+      return { ...state, config: action.payload }
+    }
+    case 'SET_LOADING': {
+      return { ...state, loading: action.payload }
+    }
+    case 'SET_URL_MARKUP': {
+      return { ...state, urlMarkup: action.payload }
+    }
+    case 'SET_MARKUP_ERROR': {
+      return { ...state, markupError: action.payload }
+    }
+    case 'SET_ERROR_MESSAGE': {
+      return { ...state, errorMessage: action.payload }
+    }
+    case 'SET_COVE_LOADED_HAS_RAN': {
+      return { ...state, coveLoadedHasRan: action.payload }
+    }
+  }
+}
+
+export default reducer

package/src/types/Config.ts

@@ -0,0 +1,16 @@
+// todo: improve base config to extend from
+// todo: theme type is different from waffle chart so its been assigned to any for now.
+export type Config = {
+  title: string
+  showHeader: boolean
+  type: string
+  srcUrl: string
+  theme: any
+  visual: {
+    border: boolean
+    accent: boolean
+    background: boolean
+    hideBackgroundColor: boolean
+    borderColorTheme: boolean
+  }
+}