@cdc/chart 4.26.1 → 4.26.3

package/CLAUDE.local.md

@@ -0,0 +1,79 @@
+# @cdc/chart — Package Rules
+
+## Entry Point Pattern
+- `CdcChart.tsx` (wrapper) — handles data fetching, config loading, CSV parsing. Does NOT set up state or context.
+- `CdcChartComponent.tsx` (main, ~1540 lines) — sets up useReducer, both context providers, data transformation, and chart rendering orchestration.
+- Do not confuse the two. Data loading changes go in the wrapper; rendering/state changes go in the main component.
+
+## Chart Types
+Each visualization type is a **separate component** in `src/components/`:
+
+| visualizationType | Component | Notes |
+|---|---|---|
+| `'Bar'` | `BarChart/` | Has sub-components: Horizontal, Vertical, StackedHorizontal, StackedVertical |
+| `'Line'` | `LineChart/` | Circle and BumpCircle sub-components |
+| `'Pie'` | `PieChart/` | |
+| `'Scatter Plot'` | `ScatterPlot/` | |
+| `'Area Chart'` | `AreaChart/` | |
+| `'Box Plot'` | `BoxPlot/` | |
+| `'Forest Plot'` | `ForestPlot/` | |
+| `'Sankey'` | `Sankey/` | Uses d3-sankey |
+| `'Bump Chart'` | `BumpChart/` | |
+| `'Combo'` | `Combo/` | Mixed bar + line |
+| `'Forecasting'` | `Forecasting/` | |
+| `'Deviation Bar'` | `DeviationBar/` | |
+| `'Paired Bar'` | `PairedBar/` | |
+| `'Spark Line'` | `Sparkline/` | |
+| `'Warming Stripes'` | `WarmingStripes/` | |
+
+CdcChartComponent routes to the correct component based on `config.visualizationType`:
+- Pie → `<PieChart />`
+- Sankey → `<SankeyChart />`
+- Spark Line → `<SparkLine />`
+- Everything else → `<LinearChart />` (shared SVG container)
+
+## State Management
+
+### Actions (16 types in `store/chart.actions.ts`):
+`SET_CONFIG`, `UPDATE_CONFIG`, `SET_COLOR_SCALE`, `SET_STATE_DATA`, `SET_EXCLUDED_DATA`, `SET_FILTERED_DATA`, `SET_SERIES_HIGHLIGHT`, `SET_VIEWPORT`, `SET_VIZ_VIEWPORT`, `SET_DIMENSIONS`, `SET_CONTAINER`, `SET_LOADED_EVENT`, `SET_DRAG_ANNOTATIONS`, `SET_LOADING`, `SET_BRUSH_DATA`
+
+### Context (`ConfigContext.tsx`):
+- `ConfigContext` — read-only state (ChartContext type)
+- `ChartDispatchContext` — dispatch function
+- ChartContext provides: `config`, `colorScale`, `transformedData`, `rawData`, `tableData`, formatting functions (`formatDate`, `formatNumber`, `parseDate`), accessibility helpers, refs (`legendRef`, `parentRef`, `svgRef`), viewport info, and editor flags.
+
+## Key Hooks (in `src/hooks/`)
+- `useScales` (528 lines) — generates xScale, yScale, seriesScale for all chart types. Returns `{ xScale, yScale, seriesScale, min, max, leftMax, rightMax }`.
+- `useTooltip` (720 lines) — tooltip mouse handlers, series filtering, formatting. Returns handlers and `TooltipListItem` component.
+- `useReduceData` — memoized min/max/stats computation.
+- `useRightAxis` — dual Y-axis support (series can specify `axis: 'right'`).
+- `useHighlightedBars` — bar highlighting logic.
+- `useIntersectionObserver` — lazy loading / viewport detection.
+
+## Where to Put New Code
+
+| What you're adding | Where it goes |
+|---|---|
+| New chart type | `src/components/<ChartType>/` with `index.tsx` exporting main component |
+| Chart-specific helper | `src/helpers/<name>.ts` |
+| Chart-specific hook | `src/hooks/use<Name>.ts` |
+| Chart-specific type | `src/types/<Name>.ts` |
+| New action | `src/store/chart.actions.ts` (add type) + `src/store/chart.reducer.ts` (add case) |
+| Story | `src/_stories/<ChartType>.stories.tsx` with mock data in `src/_stories/_mock/` |
+
+## Non-Obvious Patterns
+- **Runtime config**: `config.runtime` is computed at render time by `getNewRuntime()` — contains `seriesKeys`, `seriesLabelsAll`, `barSeriesKeys`, `lineSeriesKeys`. Not part of initial state.
+- **Dynamic categories**: Series can have `dynamicCategory` field where the series key becomes a category value from pivoted data. Check `originalDataKey` for the source column.
+- **Brush data priority**: `getTransformedData()` uses brushData > filteredData > excludedData (first non-empty wins).
+- **Two viewports**: `currentViewport` = overall container size, `vizViewport` = chart area only. Tick counts and legend layout depend on these.
+- **Color scale precedence**: `customColorsOrdered` (1:1 mapping) > `customColors` > palette name > fallback palette.
+- **Preliminary data / suppression**: `config.preliminaryData` stores effect/suppression icons that affect legend, tooltips, and line styles.
+- **Image ID**: Each chart gets a unique `imageId` (`cove-<random>`) for SVG gradient/pattern IDs to avoid collisions when multiple charts are on one page.
+- **Line-to-bar conversion**: `allowLineToBarGraph` + `isConvertLineToBarGraph()` — line charts can auto-convert to bars under certain conditions.
+- **Small multiples**: `config.smallMultiples.mode` can be `'by-column'` or `'by-series'`. Each tile gets its own data slice. `synchronizedTooltips` enables cross-tile hover.
+
+## SCSS
+- `src/scss/main.scss` — all styles scoped under `.cdc-open-viz-module.type-chart`
+- Imports `@cdc/core/styles/utils/breakpoints` for responsive mixins
+- Animation keyframes: `revealLolly`, `dash`, `growBar`, `growBarH`
+- Legend positions: `.legend-top`, `.legend-left`, `.legend-right`, `.legend-bottom`

package/LICENSE

@@ -0,0 +1,201 @@
+                                 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.

package/dist/{cdcchart-dgT_1dIT.es.js → cdcchart-DQ00cQCm.es.js}

@@ -1,22 +1,3 @@
-/*!
- * html2canvas 1.4.1 <https://html2canvas.hertzen.com>
- * Copyright (c) 2022 Niklas von Hertzen <https://hertzen.com>
- * Released under MIT License
- */
-/*! *****************************************************************************
-Copyright (c) Microsoft Corporation.
-
-Permission to use, copy, modify, and/or distribute this software for any
-purpose with or without fee is hereby granted.
-
-THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
-REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
-AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
-INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
-LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
-OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
-PERFORMANCE OF THIS SOFTWARE.
-***************************************************************************** */
 var mr = function(e, A) {
   return mr = Object.setPrototypeOf || { __proto__: [] } instanceof Array && function(t, r) {
     t.__proto__ = r;
@@ -3551,7 +3532,7 @@ var qi = 1, Ur = 2, Fr = 3, Tt = 4, St = 5, ji = 7, Ot = 8, hr = 9, dr = 10, Mt
             var i = (t = A.getContext("webgl2")) !== null && t !== void 0 ? t : A.getContext("webgl");
             if (i) {
               var a = i.getContextAttributes();
-              (a == null ? void 0 : a.preserveDrawingBuffer) === !1 && this.context.logger.warn("Unable to clone WebGL context as it has preserveDrawingBuffer=false", A);
+              a?.preserveDrawingBuffer === !1 && this.context.logger.warn("Unable to clone WebGL context as it has preserveDrawingBuffer=false", A);
             }
             s.drawImage(A, 0, 0);
           }