@cdc/map 4.25.3 → 4.25.5-1

package/src/store/map.actions.ts

@@ -0,0 +1,46 @@
+import { MapConfig, Coordinate } from '../types/MapConfig'
+import { GeneratedLegend } from '../hooks/useGenerateRuntimeLegend'
+import { VizFilter } from '@cdc/core/types/VizFilter'
+import { type Action } from '@cdc/core/types/Action'
+import { RuntimeData } from '../types/RuntimeData'
+import { Modal } from '../types/Modal'
+
+// Action Types
+type SET_ACCESSIBLE_STATUS = Action<'SET_ACCESSIBLE_STATUS', string>
+type SET_CONFIG = Action<'SET_CONFIG', MapConfig>
+type SET_COVE_LOADED_HAS_RAN = Action<'SET_COVE_LOADED_HAS_RAN', boolean>
+type SET_DISPLAY_PANEL = Action<'SET_DISPLAY_PANEL', boolean>
+type SET_FILTERED_COUNTRY_CODE = Action<'SET_FILTERED_COUNTRY_CODE', string>
+type SET_IS_DRAGGING_ANNOTATION = Action<'SET_IS_DRAGGING_ANNOTATION', boolean>
+type SET_LOADING = Action<'SET_LOADING', boolean>
+type SET_MODAL = Action<'SET_MODAL', Modal>
+type SET_POSITION = Action<'SET_POSITION', { coordinates: Coordinate; zoom: number }>
+type SET_REQUIRED_COLUMNS = Action<'SET_REQUIRED_COLUMNS', string[]>
+type SET_RUNTIME_DATA = Action<'SET_RUNTIME_DATA', RuntimeData>
+type SET_RUNTIME_FILTERS = Action<'SET_RUNTIME_FILTERS', VizFilter[]>
+type SET_RUNTIME_LEGEND = Action<'SET_RUNTIME_LEGEND', GeneratedLegend | []>
+type SET_SCALE = Action<'SET_SCALE', number>
+type SET_STATE_TO_SHOW = Action<'SET_STATE_TO_SHOW', string>
+type SET_TOPO_DATA = Action<'SET_TOPO_DATA', any>
+type SET_TRANSLATE = Action<'SET_TRANSLATE', [number, number]>
+
+export type MapActions =
+  | SET_ACCESSIBLE_STATUS
+  | SET_CONFIG
+  | SET_COVE_LOADED_HAS_RAN
+  | SET_DISPLAY_PANEL
+  | SET_FILTERED_COUNTRY_CODE
+  | SET_IS_DRAGGING_ANNOTATION
+  | SET_LOADING
+  | SET_MODAL
+  | SET_POSITION
+  | SET_REQUIRED_COLUMNS
+  | SET_RUNTIME_DATA
+  | SET_RUNTIME_FILTERS
+  | SET_RUNTIME_LEGEND
+  | SET_SCALE
+  | SET_STATE_TO_SHOW
+  | SET_TOPO_DATA
+  | SET_TRANSLATE
+
+export default MapActions

package/src/store/map.reducer.ts

@@ -0,0 +1,96 @@
+import { MapConfig } from '../types/MapConfig'
+import MapActions from './map.actions'
+import defaults from './../data/initial-state'
+import { devToolsWrapper } from '@cdc/core/helpers/withDevTools'
+import _ from 'lodash'
+
+export const getInitialState = (configObj = {}): MapState => {
+  return {
+    dataUrl: configObj.dataUrl || '',
+    config: _.merge({}, defaults, configObj),
+    loading: false,
+    accessibleStatus: '',
+    coveLoadedHasRan: false,
+    displayPanel: false,
+    filteredCountryCode: '',
+    isDraggingAnnotation: false,
+    topoData: null,
+    translate: [0, 0],
+    position: { coordinates: [0, 0], zoom: 1 },
+    projection: null,
+    requiredColumns: [],
+    scale: 1,
+    modal: null,
+    runtimeData: { init: true },
+    runtimeFilters: [],
+    runtimeLegend: [],
+    stateToShow: ''
+  }
+}
+
+export type MapState = {
+  config: MapConfig
+  loading: boolean
+  accessibleStatus: string
+  coveLoadedHasRan: boolean
+  displayPanel: boolean
+  filteredCountryCode: string
+  isDraggingAnnotation: boolean
+  topoData: object | null
+  translate: number[]
+  position: { coordinates: number[]; zoom: number }
+  projection: object | null
+  requiredColumns: string[]
+  scale: number
+  modal: object | null
+  runtimeData: object
+  runtimeFilters: object[]
+  runtimeLegend: object[]
+  stateToShow: string
+  dataUrl: string
+}
+
+const reducer = (state: MapState, action: MapActions): MapState => {
+  switch (action.type) {
+    case 'SET_CONFIG':
+      return { ...state, config: action.payload }
+    case 'SET_LOADING':
+      return { ...state, loading: action.payload }
+    case 'SET_ACCESSIBLE_STATUS':
+      return { ...state, accessibleStatus: action.payload }
+    case 'SET_COVE_LOADED_HAS_RAN':
+      return { ...state, coveLoadedHasRan: action.payload }
+    case 'SET_DISPLAY_PANEL':
+      return { ...state, displayPanel: action.payload }
+    case 'SET_FILTERED_COUNTRY_CODE':
+      return { ...state, filteredCountryCode: action.payload }
+    case 'SET_IS_DRAGGING_ANNOTATION':
+      return { ...state, isDraggingAnnotation: action.payload }
+    case 'SET_TOPO_DATA':
+      return { ...state, topoData: action.payload }
+    case 'SET_TRANSLATE':
+      return { ...state, translate: action.payload }
+    case 'SET_POSITION':
+      return { ...state, position: action.payload }
+    case 'SET_REQUIRED_COLUMNS':
+      return { ...state, requiredColumns: action.payload }
+    case 'SET_SCALE':
+      return { ...state, scale: action.payload }
+    case 'SET_MODAL':
+      return { ...state, modal: action.payload }
+    case 'SET_RUNTIME_DATA':
+      return { ...state, runtimeData: action.payload }
+    case 'SET_RUNTIME_FILTERS':
+      return { ...state, runtimeFilters: action.payload }
+    case 'SET_RUNTIME_LEGEND':
+      return { ...state, runtimeLegend: action.payload }
+    case 'SET_STATE_TO_SHOW':
+      return { ...state, stateToShow: action.payload }
+    default:
+      return state
+  }
+}
+
+export const mapReducer = devToolsWrapper(reducer)
+
+export type MapReducerType<MapState, MapActions> = (state: MapState, action: MapActions) => MapState

package/src/types/Annotations.ts

@@ -0,0 +1,24 @@
+type Annotation = {
+  /** The x-coordinate of the annotation */
+  x: number
+  /** The y-coordinate of the annotation */
+  y: number
+  /** The x-offset for the annotation's text */
+  dx: number
+  /** The y-offset for the annotation's text */
+  dy: number
+  /** The opacity level of the annotation */
+  opacity: number
+  /** The text content of the annotation */
+  text: string
+  /** The type of connection for the annotation */
+  connectionType: string
+  edit: {
+    /** Indicates if the label can be edited */
+    label: boolean
+    /** Indicates if the subject can be edited */
+    subject: boolean
+  }
+  /** The type of marker used for the annotation */
+  marker: 'arrow' | 'circle'
+}

package/src/types/MapConfig.ts

@@ -23,7 +23,7 @@ export type MapVisualSettings = {
   additionalCityStyles: [] | [{ label: string; column: string; value: string; shape: string }]
 }
 
-type PatternSelection = {
+export type PatternSelection = {
   // dropdown selection for getting the column used on a pattern
   dataKey: string
   // text field input to match values found in the column
@@ -68,9 +68,17 @@ export type HexMapSettings = {
 
 export type Coordinate = [number, number]
 
+export type DataRow = {
+  uid?: string // optional 'uid' property
+  [key: string]: any // allowing any additional properties with a dynamic key (e.g., for `configPrimaryName`)
+}
+
 export type MapConfig = Visualization & {
-  color: string // map color palette
-  customColors: string[] // custom color palette
+  annotations: Annotation[]
+  // map color palette
+  color: string
+  // custom color palette
+  customColors: string[]
   columns: {
     geo: GeoColumnProperties
     primary: PrimaryColumnProperties
@@ -80,9 +88,13 @@ export type MapConfig = Visualization & {
     categorical: { name: string }
   }
   dataUrl: string
+  data: DataRow[]
   runtimeDataUrl: string
   filters: VizFilter[]
   general: {
+    navigationTarget: '_self' | '_blank'
+    subtext: string
+    introText: string
     allowMapZoom: boolean
     convertFipsCodes: boolean
     displayAsHex: boolean
@@ -90,6 +102,8 @@ export type MapConfig = Visualization & {
     fullBorder: boolean
     geoBorderColor: string
     geoLabelOverride: string
+    // whether to use the old custom quantile scaling method or new custom quantile scaling method
+    equalNumberOptIn: boolean
     geoType:
       | 'us'
       | 'us-region'
@@ -109,6 +123,8 @@ export type MapConfig = Visualization & {
       isReversed: boolean
     }
     showDownloadMediaButton: boolean
+    showDownloadImgButton: boolean
+    showDownloadPdfButton: boolean
     showSidebar: boolean
     showTitle: boolean
     statePicked: {
@@ -142,6 +158,7 @@ export type MapConfig = Visualization & {
     tickRotation: string
     hideBorder: false
     singleColumnLegend: false
+    separators?: string
   }
   table: {
     label: string
@@ -154,6 +171,7 @@ export type MapConfig = Visualization & {
     forceDisplay: boolean
     download: boolean
     indexLabel: string
+    cellMinWidth: string
   }
   tooltips: {
     appearanceType: 'hover' | 'click'
@@ -175,6 +193,8 @@ export type MapConfig = Visualization & {
   filterBehavior: string
   filterIntro: string
   visual: MapVisualSettings
+  // visualization type
+  type: 'map'
   // version of the map
   version: Version
 }

package/src/types/MapContext.ts

@@ -1,51 +1,52 @@
-import { type MapConfig } from './MapConfig'
+import { DataRow, type MapConfig } from './MapConfig'
 import { type ViewPort } from '@cdc/core/types/ViewPort'
+import { DimensionsType } from '@cdc/core/types/Dimensions'
+import { VizFilter } from '@cdc/core/types/VizFilter'
+import { type RefObject } from 'react'
 
 export type MapContext = {
-  applyLegendToRow
-  applyTooltipsToGeo
   currentViewport: ViewPort
-  data
-  displayDataAsText
-  displayGeoName
-  filteredCountryCode
-  generateColorsArray
-  generateRuntimeData
-  geoClickHandler
+  content: { geoName: string; keyedData: Record<string, any> }
+  data: DataRow[]
+  dimensions: DimensionsType
+  displayDataAsText: string | number
+  displayGeoName: (key: string, convertFipsCodes: boolean) => string
+  filteredCountryCode: string
+  generateRuntimeData: (
+    configObj: MapConfig,
+    filters: VizFilter[],
+    hash: number,
+    test?: boolean
+  ) => { [uid: string]: DataRow }
+  geoClickHandler: (geoDisplayName: string, geoData: object) => void
   handleCircleClick: Function
   handleDragStateChange: Function
   isDraggingAnnotation: boolean
-  hasZoom
-  innerContainerRef
-  isDashboard
-  isDebug
-  isEditor
+  innerContainerRef: RefObject<HTMLDivElement>
+  isDashboard: boolean
+  isEditor: boolean
   isFilterValueSupported: boolean
-  loadConfig
+  loadConfig: (configObj: MapConfig) => void
   logo: string
-  position
-  resetLegendToggles
-  runtimeFilters
+  mapId: string
+  position: 'side' | 'top' | 'bottom'
+  resetLegendToggles: Function
+  runtimeFilters: Function
+  legendMemo: Function
+  legendSpecialClassLastMemo: Function
   runtimeLegend
-  setAccessibleStatus
-  setFilteredCountryCode
-  setParentConfig
-  setPosition
-  setRuntimeData
-  setRuntimeFilters
-  setRuntimeLegend
-  setSharedFilterValue
-  setState: (newState: MapConfig) => MapConfig
-  state: MapConfig
-  viewport
-  setStateToShow: (string) => void
+  setParentConfig: Function
+  setRuntimeData: Function
+  setRuntimeFilters: Function
+  setRuntimeLegend: Function
+  setSharedFilterValue: Function
+  setConfig: (newState: MapConfig) => MapConfig
+  config: MapConfig
+  viewport: ViewPort
   stateToShow: string
   scale: number
   translate: [number, number]
-  topoData
-  setScale: (number) => void
-  setTranslate: ([x, y]: [number, number]) => void
+  topoData: object
   runtimeData: Object[]
   tooltipId: string
-  setTopoData: Function
 }

package/src/types/Modal.ts

@@ -0,0 +1 @@
+export type Modal = { geoName: string; keyedData: Record<string, any>[] }

package/src/types/RuntimeData.ts

@@ -0,0 +1,3 @@
+import { DataRow } from './MapConfig'
+
+export type RuntimeData = { [uid: string]: DataRow }[]

package/LICENSE

@@ -1,201 +0,0 @@
-                                 Apache License
-                           Version 2.0, January 2004
-                        http://www.apache.org/licenses/
-
-   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
-
-   1. Definitions.
-
-      "License" shall mean the terms and conditions for use, reproduction,
-      and distribution as defined by Sections 1 through 9 of this document.
-
-      "Licensor" shall mean the copyright owner or entity authorized by
-      the copyright owner that is granting the License.
-
-      "Legal Entity" shall mean the union of the acting entity and all
-      other entities that control, are controlled by, or are under common
-      control with that entity. For the purposes of this definition,
-      "control" means (i) the power, direct or indirect, to cause the
-      direction or management of such entity, whether by contract or
-      otherwise, or (ii) ownership of fifty percent (50%) or more of the
-      outstanding shares, or (iii) beneficial ownership of such entity.
-
-      "You" (or "Your") shall mean an individual or Legal Entity
-      exercising permissions granted by this License.
-
-      "Source" form shall mean the preferred form for making modifications,
-      including but not limited to software source code, documentation
-      source, and configuration files.
-
-      "Object" form shall mean any form resulting from mechanical
-      transformation or translation of a Source form, including but
-      not limited to compiled object code, generated documentation,
-      and conversions to other media types.
-
-      "Work" shall mean the work of authorship, whether in Source or
-      Object form, made available under the License, as indicated by a
-      copyright notice that is included in or attached to the work
-      (an example is provided in the Appendix below).
-
-      "Derivative Works" shall mean any work, whether in Source or Object
-      form, that is based on (or derived from) the Work and for which the
-      editorial revisions, annotations, elaborations, or other modifications
-      represent, as a whole, an original work of authorship. For the purposes
-      of this License, Derivative Works shall not include works that remain
-      separable from, or merely link (or bind by name) to the interfaces of,
-      the Work and Derivative Works thereof.
-
-      "Contribution" shall mean any work of authorship, including
-      the original version of the Work and any modifications or additions
-      to that Work or Derivative Works thereof, that is intentionally
-      submitted to Licensor for inclusion in the Work by the copyright owner
-      or by an individual or Legal Entity authorized to submit on behalf of
-      the copyright owner. For the purposes of this definition, "submitted"
-      means any form of electronic, verbal, or written communication sent
-      to the Licensor or its representatives, including but not limited to
-      communication on electronic mailing lists, source code control systems,
-      and issue tracking systems that are managed by, or on behalf of, the
-      Licensor for the purpose of discussing and improving the Work, but
-      excluding communication that is conspicuously marked or otherwise
-      designated in writing by the copyright owner as "Not a Contribution."
-
-      "Contributor" shall mean Licensor and any individual or Legal Entity
-      on behalf of whom a Contribution has been received by Licensor and
-      subsequently incorporated within the Work.
-
-   2. Grant of Copyright License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      copyright license to reproduce, prepare Derivative Works of,
-      publicly display, publicly perform, sublicense, and distribute the
-      Work and such Derivative Works in Source or Object form.
-
-   3. Grant of Patent License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      (except as stated in this section) patent license to make, have made,
-      use, offer to sell, sell, import, and otherwise transfer the Work,
-      where such license applies only to those patent claims licensable
-      by such Contributor that are necessarily infringed by their
-      Contribution(s) alone or by combination of their Contribution(s)
-      with the Work to which such Contribution(s) was submitted. If You
-      institute patent litigation against any entity (including a
-      cross-claim or counterclaim in a lawsuit) alleging that the Work
-      or a Contribution incorporated within the Work constitutes direct
-      or contributory patent infringement, then any patent licenses
-      granted to You under this License for that Work shall terminate
-      as of the date such litigation is filed.
-
-   4. Redistribution. You may reproduce and distribute copies of the
-      Work or Derivative Works thereof in any medium, with or without
-      modifications, and in Source or Object form, provided that You
-      meet the following conditions:
-
-      (a) You must give any other recipients of the Work or
-          Derivative Works a copy of this License; and
-
-      (b) You must cause any modified files to carry prominent notices
-          stating that You changed the files; and
-
-      (c) You must retain, in the Source form of any Derivative Works
-          that You distribute, all copyright, patent, trademark, and
-          attribution notices from the Source form of the Work,
-          excluding those notices that do not pertain to any part of
-          the Derivative Works; and
-
-      (d) If the Work includes a "NOTICE" text file as part of its
-          distribution, then any Derivative Works that You distribute must
-          include a readable copy of the attribution notices contained
-          within such NOTICE file, excluding those notices that do not
-          pertain to any part of the Derivative Works, in at least one
-          of the following places: within a NOTICE text file distributed
-          as part of the Derivative Works; within the Source form or
-          documentation, if provided along with the Derivative Works; or,
-          within a display generated by the Derivative Works, if and
-          wherever such third-party notices normally appear. The contents
-          of the NOTICE file are for informational purposes only and
-          do not modify the License. You may add Your own attribution
-          notices within Derivative Works that You distribute, alongside
-          or as an addendum to the NOTICE text from the Work, provided
-          that such additional attribution notices cannot be construed
-          as modifying the License.
-
-      You may add Your own copyright statement to Your modifications and
-      may provide additional or different license terms and conditions
-      for use, reproduction, or distribution of Your modifications, or
-      for any such Derivative Works as a whole, provided Your use,
-      reproduction, and distribution of the Work otherwise complies with
-      the conditions stated in this License.
-
-   5. Submission of Contributions. Unless You explicitly state otherwise,
-      any Contribution intentionally submitted for inclusion in the Work
-      by You to the Licensor shall be under the terms and conditions of
-      this License, without any additional terms or conditions.
-      Notwithstanding the above, nothing herein shall supersede or modify
-      the terms of any separate license agreement you may have executed
-      with Licensor regarding such Contributions.
-
-   6. Trademarks. This License does not grant permission to use the trade
-      names, trademarks, service marks, or product names of the Licensor,
-      except as required for reasonable and customary use in describing the
-      origin of the Work and reproducing the content of the NOTICE file.
-
-   7. Disclaimer of Warranty. Unless required by applicable law or
-      agreed to in writing, Licensor provides the Work (and each
-      Contributor provides its Contributions) on an "AS IS" BASIS,
-      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-      implied, including, without limitation, any warranties or conditions
-      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
-      PARTICULAR PURPOSE. You are solely responsible for determining the
-      appropriateness of using or redistributing the Work and assume any
-      risks associated with Your exercise of permissions under this License.
-
-   8. Limitation of Liability. In no event and under no legal theory,
-      whether in tort (including negligence), contract, or otherwise,
-      unless required by applicable law (such as deliberate and grossly
-      negligent acts) or agreed to in writing, shall any Contributor be
-      liable to You for damages, including any direct, indirect, special,
-      incidental, or consequential damages of any character arising as a
-      result of this License or out of the use or inability to use the
-      Work (including but not limited to damages for loss of goodwill,
-      work stoppage, computer failure or malfunction, or any and all
-      other commercial damages or losses), even if such Contributor
-      has been advised of the possibility of such damages.
-
-   9. Accepting Warranty or Additional Liability. While redistributing
-      the Work or Derivative Works thereof, You may choose to offer,
-      and charge a fee for, acceptance of support, warranty, indemnity,
-      or other liability obligations and/or rights consistent with this
-      License. However, in accepting such obligations, You may act only
-      on Your own behalf and on Your sole responsibility, not on behalf
-      of any other Contributor, and only if You agree to indemnify,
-      defend, and hold each Contributor harmless for any liability
-      incurred by, or claims asserted against, such Contributor by reason
-      of your accepting any such warranty or additional liability.
-
-   END OF TERMS AND CONDITIONS
-
-   APPENDIX: How to apply the Apache License to your work.
-
-      To apply the Apache License to your work, attach the following
-      boilerplate notice, with the fields enclosed by brackets "[]"
-      replaced with your own identifying information. (Don't include
-      the brackets!)  The text should be enclosed in the appropriate
-      comment syntax for the file format. We also recommend that a
-      file or class name and description of purpose be included on the
-      same "printed page" as the copyright notice for easier
-      identification within third-party archives.
-
-   Copyright [yyyy] [name of copyright owner]
-
-   Licensed under the Apache License, Version 2.0 (the "License");
-   you may not use this file except in compliance with the License.
-   You may obtain a copy of the License at
-
-       http://www.apache.org/licenses/LICENSE-2.0
-
-   Unless required by applicable law or agreed to in writing, software
-   distributed under the License is distributed on an "AS IS" BASIS,
-   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-   See the License for the specific language governing permissions and
-   limitations under the License.