@cdc/core 4.24.4 → 4.24.7

package/package.json

@@ -1,12 +1,13 @@
 {
   "name": "@cdc/core",
-  "version": "4.24.4",
+  "version": "4.24.7",
   "description": "Core components, styles, hooks, and helpers, for the CDC Open Visualization project",
   "moduleName": "CdcCore",
   "main": "dist/cdccore",
   "scripts": {
-    "test": "vitest watch --reporter verbose --globals true",
-    "test:ui": "vitest --ui"
+    "test": "vitest run --reporter verbose",
+    "test-watch": "vitest watch --reporter verbose",
+    "test-watch:ui": "vitest --ui"
   },
   "repository": {
     "type": "git",
@@ -20,6 +21,7 @@
   "license": "Apache-2.0",
   "dependencies": {
     "html2canvas": "^1.4.1",
+    "json-edit-react": "^1.12.0",
     "papaparse": "^5.3.0",
     "prop-types": "^15.8.1",
     "react-accessible-accordion": "^5.0.0",
@@ -31,5 +33,5 @@
     "react": "^18.2.0",
     "react-dom": "^18.2.0"
   },
-  "gitHead": "1843b4632140d582af6a87606374cbd4fe25ad5c"
+  "gitHead": "7a7372d03778cb977e0e92e3b3bc1a35f8a5bfaf"
 }

package/styles/_button-section.scss

@@ -17,10 +17,15 @@
   padding: 0px 1em;
   display: flex;
   justify-content: flex-end;
-
+  &.brush-active {
+    margin-top: 2em;
+  }
   a:not(:last-child) {
     margin-right: 10px;
   }
+  & a {
+    font-size: 16px;
+  }
 }
 
 // odd wrapper thats different on dashboards

package/styles/_data-table.scss

@@ -13,7 +13,6 @@ div.data-table-heading {
   background: rgba(0, 0, 0, 0.05);
   padding: 0.5em 0.7em;
   border: $lightGray 1px solid;
-  border-bottom: 0;
   cursor: pointer;
 
   svg {

package/styles/_reset.scss

@@ -141,15 +141,16 @@
     top: -0.5em;
   }
 
-  header sup {
-    /* Allow line breaks using html in the header. */
-    top: initial;
-    line-height: initial;
-  }
-
   sub {
     /* Move the subscripted text down, but only
       half as far down as the superscript moved up */
     bottom: -0.25em;
   }
+
+  ul > li:first-child {
+    margin-top: auto;
+  }
+  ul > li:last-of-type {
+    margin-bottom: auto;
+  }
 }

package/styles/base.scss

@@ -77,6 +77,10 @@ body.post-type-cdc_visualization .cdc-editor .configure .editor-panel {
   @import 'series-list';
   @import 'typography';
 
+  input[type='range'] {
+    appearance: auto !important;
+  }
+
   // Force printing chart images
   -webkit-print-color-adjust: exact !important; /* Chrome, Safari 6 – 15.3, Edge */
   color-adjust: exact !important; /* Firefox 48 – 96 */

package/styles/v2/themes/_color-definitions.scss

@@ -76,6 +76,7 @@ $theme: (
 .markup-include,
 .type-waffle-chart,
 .type-data-bite,
+.type-filtered-text,
 .cdc-open-viz-module.type-chart.type-sparkline,
 .cove {
   @each $theme-name, $theme-colors in $theme {

package/types/Annotation.ts

@@ -0,0 +1,46 @@
+export type Annotation = {
+  // background opacity of annotation
+  opacity: number
+  // HTML text string to display in annotation
+  text: string
+  // can the user edit/drag the annotation
+  edit: {
+    subject: boolean
+    label: boolean
+  }
+  // if the connectionType is curve - allow choosing a visx curve type
+  lineType: string
+  // anchor points for lines
+  anchor: {
+    horizontal: boolean
+    vertical: boolean
+  }
+  // x value for scaling
+  xKey: string
+  // y value for scaling
+  yKey: string
+  // orignal x value of subject
+  originalX: number
+  // x of subject
+  x: number
+  // y of object
+  y: number
+  // x offset of label from subject
+  dx: number
+  // y offset of label from subject
+  dy: number
+  // assigned series that the annotation should snap to
+  seriesKey: string
+  // if the dragged item should be snapped to the nearest point
+  snapToNearestPoint: boolean
+  // type of  connecting line from label to subject
+  connectionType: 'line' | 'curve' | 'elbow' | 'none'
+  // marker type highlighting the subject
+  marker: 'arrow' | 'circle'
+  // should the item be snapped to the subject?
+  snapToSubject: boolean
+  // savedDimensions - the original dimensions of the svg when the svg was saved
+  savedDimensions: [width: number, height: number]
+  // displayDropdown - whether or not to show the mobile dropdown on desktop for annotations
+  displayDropdown?: boolean
+}

package/types/Column.ts

@@ -6,6 +6,7 @@ export type Column = {
   roundToPlace: number
   commas: boolean
   dataTable: boolean
+  order?: number
   showInViz: boolean
   startingPoint: string
   series?: string

package/types/ConfigureData.ts

@@ -2,7 +2,7 @@ import { DataDescription } from './DataDescription'
 
 export type ConfigureData = {
   dataDescription: Partial<DataDescription>
-  data: Object[]
+  data?: Object[]
   formattedData?: Object[]
   dataKey: string // This is the key of the dataset in the config
 }

package/types/Footnotes.ts

@@ -0,0 +1,17 @@
+import { Visualization } from './Visualization'
+
+export type Footnote = {
+  symbol?: string
+  text: string
+}
+
+type Footnotes = Visualization & {
+  dynamicFootnotes?: {
+    symbolColumn?: string
+    textColumn: string
+    orderColumn?: string
+  }
+  staticFootnotes?: Footnote[]
+}
+
+export default Footnotes

package/types/General.ts

@@ -6,4 +6,9 @@ export type General = {
   type: string
   showDownloadButton: boolean
   allowMapZoom?: boolean
+  showMissingDataLabel: boolean
+  showSuppressedSymbol: boolean
+  showZeroValueDataLabel: boolean
+  showAnnotationDropdown?: boolean
+  title: string
 }

package/types/Legend.ts

@@ -7,6 +7,7 @@ export type Legend = {
   description: string
   // show or hide the legend
   hide: boolean
+  hideSuppressedLabels: boolean
   highlightOnHover: boolean
   label: string
   lineMode: boolean

package/types/MarkupInclude.ts

@@ -0,0 +1,26 @@
+import { Runtime } from '@cdc/core/types/Runtime'
+import { Variable } from '@cdc/markup-include/src/types/Variable'
+import { Visualization } from './Visualization'
+
+export type MarkupIncludeConfig = Visualization & {
+  contentEditor: {
+    // Changing the base config object creates an infinite loop, nesting it is a workaround
+    inlineHTML: string
+    markupVariables: Variable[]
+    showHeader: boolean
+    srcUrl: string
+    title: string
+    useInlineHTML: boolean
+  }
+  data?: Object[]
+  formattedData: {}
+  newViz?: boolean
+  runtime?: Runtime
+  visual: {
+    border: boolean
+    accent: boolean
+    background: boolean
+    hideBackgroundColor: boolean
+    borderColorTheme: boolean
+  }
+}

package/types/Runtime.ts

@@ -7,13 +7,8 @@ export type ForecastingSeriesKey = {
   }[]
 }
 
-export type BarSeriesKey = {
-  key: string
-  color: string
-}
-
 export type Runtime = {
-  barSeriesKeys?: BarSeriesKey[]
+  barSeriesKeys?: string[]
   forecastingSeriesKeys?: ForecastingSeriesKey[]
   originalXAxis: {
     dataKey: string
@@ -26,6 +21,7 @@ export type Runtime = {
   seriesLabels: Record<string, any>
   seriesLabelsAll: string[]
   editorErrorMessage: string
-  lineSeriesKeys: any[]
+  lineSeriesKeys?: string[]
   horizontal: boolean
+  uniqueId: number | string
 }

package/types/Series.ts

@@ -1 +1 @@
-export type Series = { dataKey: string; name: string; axis: string; type: string }[]
+export type Series = { dataKey: string; name: string; axis: string; type: string; tooltip: boolean }[]

package/types/Table.ts

@@ -1,22 +1,29 @@
+type Pivot = {
+  columnName: string
+  valueColumn: string
+}
+
 export type Table = {
+  caption?: string
   cellMinWidth?: number
-  label?: string
-  show?: boolean
-  showVertical?: boolean
+  collapsible?: boolean
+  dateDisplayFormat?: string
+  download?: boolean
+  downloadImageButton?: boolean
+  downloadPdfButton?: boolean
+  excludeColumns?: string[]
+  expanded?: boolean
+  fontSize: 'small' | 'medium' | 'large'
+  groupBy?: string
+  height?: number
   indexLabel?: string
-  caption?: string
+  label?: string
   limitHeight?: boolean
-  height?: number
-  expanded?: boolean
+  pivot?: Pivot
+  show?: boolean
   showDataTableLink?: boolean
-  showDownloadUrl?: boolean
-  download?: boolean
-  customTableConfig?: boolean
-  excludeColumns?: string[]
   showDownloadImgButton?: boolean
   showDownloadPdfButton?: boolean
-  downloadImageButton?: boolean
-  downloadPdfButton?: boolean
-  dateDisplayFormat?: string
-  fontSize: 'small' | 'medium' | 'large'
+  showDownloadUrl?: boolean
+  showVertical?: boolean
 }

package/types/Visualization.ts

@@ -4,33 +4,62 @@ import { Column } from './Column'
 import { Series } from './Series'
 import { Table } from './Table'
 import { ConfidenceInterval } from './ConfidenceInterval'
-import { BaseVisualizationType } from './BaseVisualizationType'
 import { ConfigureData } from './ConfigureData'
+import { VizFilter } from './VizFilter'
+import { FilterBehavior } from './FilterBehavior'
+import { General } from './General'
+import { Runtime } from './Runtime'
+import { DashboardFilters } from '@cdc/dashboard/src/types/DashboardFilters'
 
-export type Visualization = ConfigureData & {
-  autoLoad: boolean
-  columns: Record<string, Column>
+// This was originally created as a catchall for the different types of visualizations.
+// Currently it includes properties that ares specific to one Visualization type.
+// We should avoid adding any new property to this type unless it is used by all visualizations.
+// We should refactor it also to remove properties that are not used by all visualizations.
+// See AnyVisualization type below...
+type DeprecatedVisualizationType = {
+  columns: Record<string, Partial<Column>>
   confidenceKeys: ConfidenceInterval
   dataFileName: string
   dataFileSourceType: string
   dataFormat: any
   datasets: Record<string, any>
-  editing: boolean
-  general: any
-  hide: any[]
+  filters: VizFilter[]
+  general: General
   legend: Legend
   multiDashboards?: any[]
   newViz: boolean
   openModal: boolean
-  originalFormattedData: any
   orientation: 'vertical' | 'horizontal'
+  originalFormattedData: any
+  runtime?: Runtime
   series: Series
   table: Table
+  theme: string
   title: string
-  type: BaseVisualizationType
-  uid: string // this is the actual key of the visualization object
+  type: 'dashboard' | 'chart' | 'footnotes' | 'map' | 'data-bite' | 'waffle-chart' | 'markup-include' | 'filtered-text' | 'table' | 'navigation'
   usesSharedFilter: any
-  visualizationType: string
   visualizationSubType: string
+  visualizationType: string
   xAxis: Axis
+  preliminaryData: { type: 'effect' | 'suppression'; value: string }[]
+}
+
+type StatefulProperties = {
+  editing: boolean
+  newViz: boolean
 }
+
+export type CommonVisualizationProperties = Partial<StatefulProperties> & {
+  showEditorPanel?: boolean
+  uid?: string // this is the actual key of the visualization object
+  visualizationType?: string
+  filterBehavior: FilterBehavior
+} & Partial<ConfigureData>
+
+export type Visualization = DeprecatedVisualizationType & CommonVisualizationProperties
+
+// This type is used as a catchall for the different types of visualizations.
+// We should create a specific type for each visualization type and add it to this list.
+// We will remove Visualization from this list once we have all union types listed.
+// All of the New types will extend CommonVisualizationProperties.
+export type AnyVisualization = Visualization | DashboardFilters

package/types/VizFilter.ts

@@ -0,0 +1,24 @@
+export type FilterBase = {
+  columnName: string
+  values: string[]
+  showDropdown: boolean
+}
+
+export type GeneralFilter = FilterBase & {
+  active: string
+  queuedActive: string
+  filterStyle: 'tab' | 'pill' | 'tab bar' | 'dropdown' | 'dropdown bar' | 'multi-select'
+  label: string
+  order: 'asc' | 'desc' | 'cust'
+  orderedValues?: string[]
+  queryParameter: string
+  setByQueryParameter: string
+  type: 'url'
+}
+
+export type MultiSelectFilter = {
+  active: string[]
+  selectLimit: number
+} & Omit<GeneralFilter, 'active'>
+
+export type VizFilter = GeneralFilter | MultiSelectFilter

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.