@sproutsocial/seeds-react-data-viz 0.7.32 → 0.15.0

package/dist/index.d.ts

@@ -1,104 +1,15 @@
 import * as react from 'react';
 import { ReactNode } from 'react';
-import { AxisLabelsFormatterContextObject, TimeTicksInfoObject, Chart, Annotation, TooltipFormatterContextObject, Options, SeriesSplineOptions, SeriesAreasplineOptions, SeriesColumnOptions, AxisTickPositionsArray } from 'highcharts';
+import { T as TypeChartDataPoint, a as TypeChartDataStyles, b as TypeChartTooltipDateFormatter, c as TypeChartNumberFormat, d as TypeChartTooltipProps, e as TypeChartYAxisLabelFormatter, f as TypeChartTimeFormat, g as TypeChartXAnnotations, h as TypeChartStylePattern, i as TypeVerticalBarChartProps, j as TypeSeriesType, E as ExtendedTimeTicksInfoObject, k as TypeChartStyleColor, l as TypeChartStyleHasOnClick } from './types-B7ILUQ6_.js';
+export { m as ExtendedAxisLabelsFormatterContextObject, n as TypeChartXAnnotationsDetails, o as TypeExtendedChart } from './types-B7ILUQ6_.js';
 import * as _sproutsocial_seeds_react_box from '@sproutsocial/seeds-react-box';
 import { TypeBoxProps } from '@sproutsocial/seeds-react-box';
 import { Table } from '@sproutsocial/seeds-react-table';
+import { Chart, TooltipFormatterContextObject, Options, SeriesSplineOptions, SeriesAreasplineOptions, SeriesColumnOptions, AxisTickPositionsArray, AxisLabelsFormatterContextObject } from 'highcharts';
 import { TypeIconName } from '@sproutsocial/seeds-react-icon';
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import * as styled_components from 'styled-components';
 
-/**
- * Type of series to render. See {@link https://api.highcharts.com/highcharts/series} for detailed series configuration options.
- */
-type TypeSeriesType = "areaspline" | "spline" | "column";
-interface ExtendedTimeTicksInfoObject extends TimeTicksInfoObject {
-    unitName: "hour" | "day" | "week" | "month" | "year";
-}
-interface ExtendedAxisLabelsFormatterContextObject extends AxisLabelsFormatterContextObject {
-    tickPositionInfo: ExtendedTimeTicksInfoObject;
-}
-type TypeChartDataPoint = Readonly<{
-    x: number | string;
-    y: number | null;
-}>;
-type TypeChartDataStyles = Readonly<{
-    color?: TypeChartStyleColor;
-}>;
-type TypeChartNumberFormat = "decimal" | "percent" | "currency" | "duration";
-type TypeChartTimeFormat = "12" | "24";
-type TypeChartTooltipDateFormatter = ({ x, }: {
-    x: number | string;
-}) => ReactNode;
-type TypeChartTooltipProps = Readonly<{
-    data: ReadonlyArray<Readonly<{
-        color: TypeChartStyleColor;
-        name: string;
-        value: number | null;
-        icon?: ReactNode;
-    }>>;
-    x: number | string;
-}>;
-type TypeChartYAxisLabelFormatter = ({ y, yValues, }: Readonly<{
-    y: number;
-    yValues: ReadonlyArray<number>;
-}>) => string;
-type TypeChartXAnnotationsDetails = () => ReactNode;
-type TypeChartXAnnotations = Readonly<{
-    [x: number]: Readonly<{
-        marker: () => ReactNode;
-        details: TypeChartXAnnotationsDetails;
-    }>;
-}> | undefined;
-type TypeChartStyleColor = string;
-type TypeChartStylePattern = "solid" | "dashed";
-type TypeChartStyleHasOnClick = boolean;
-type TypeVerticalBarChartProps = Readonly<{
-    data: ReadonlyArray<Readonly<{
-        name: string;
-        points: ReadonlyArray<TypeChartDataPoint>;
-        icon?: ReactNode;
-        styles?: TypeChartDataStyles & Readonly<{
-            pattern?: TypeChartStylePattern;
-        }>;
-    }>>;
-    invalidNumberLabel: ReactNode;
-    numberLocale: Intl.LocalesArgument;
-    textLocale: Intl.LocalesArgument;
-    tooltipDateFormatter: TypeChartTooltipDateFormatter;
-    currency?: string;
-    numberFormat?: TypeChartNumberFormat;
-    /**
-     * The maximum number of series to display.
-     * @default 10
-     * @description We recommend limiting the number of series to 10 to maintain chart readability and accessibility.
-     */
-    seriesLimit?: number;
-    /**
-     * If false, disables the warning when the number of series exceeds the seriesLimit.
-     * @default true
-     */
-    showSeriesLimitWarning?: boolean;
-    tooltip?: ({ data, x }: TypeChartTooltipProps) => ReactNode;
-    yAxisLabelFormatter?: TypeChartYAxisLabelFormatter;
-    onClick?: ({ x }: Readonly<{
-        x: number;
-    }>) => void;
-    tooltipClickLabel?: ReactNode;
-    timeFormat?: TypeChartTimeFormat;
-    xAnnotations?: TypeChartXAnnotations;
-    xAxisLabelFormatter?: (params: {
-        textLocale: Intl.LocalesArgument;
-        tickPositions: number[];
-        unitName: string;
-        value: string | number;
-        timeFormat?: string;
-    }) => string;
-}>;
-interface TypeExtendedChart extends Chart {
-    annotations?: Annotation[];
-}
-
 type TypeAreaChartProps = Readonly<{
     data: ReadonlyArray<Readonly<{
         name: string;
@@ -126,6 +37,19 @@ type TypeAreaChartProps = Readonly<{
     timezone?: string;
     xAnnotations?: TypeChartXAnnotations;
 }>;
+/**
+ * @deprecated Use the v2 component instead:
+ *
+ * ```ts
+ * import { LineAreaChart } from "@sproutsocial/seeds-react-data-viz/line-area";
+ * ```
+ *
+ * `LineAreaChart` (with `variant="area"` or `"areaspline"`) is built on the shared
+ * v2 chart base — see `charts/README.md` for the architecture. The v2 prop shape
+ * differs from this legacy component and v2 does not yet cover every legacy
+ * feature (locale-aware tooltips, currency/number formatters, area totals).
+ * Migrate when ready; Claude-assisted migration guidance lands with the CE-10 codemod.
+ */
 declare const AreaChart: react.NamedExoticComponent<Readonly<{
     data: ReadonlyArray<Readonly<{
         name: string;
@@ -367,6 +291,19 @@ type TypeLineChartProps = Readonly<{
         timeFormat?: string;
     }) => string;
 }>;
+/**
+ * @deprecated Use the v2 component instead:
+ *
+ * ```ts
+ * import { LineAreaChart } from "@sproutsocial/seeds-react-data-viz/line-area";
+ * ```
+ *
+ * `LineAreaChart` (with `variant="line"` or `"spline"`) is built on the shared
+ * v2 chart base — see `charts/README.md` for the architecture. The v2 prop shape
+ * differs from this legacy component and v2 does not yet cover every legacy
+ * feature (locale-aware tooltips, currency/number formatters). Migrate when ready;
+ * Claude-assisted migration guidance lands with the CE-9 codemod.
+ */
 declare const LineChart: react.NamedExoticComponent<Readonly<{
     data: ReadonlyArray<Readonly<{
         name: string;
@@ -401,6 +338,22 @@ declare const LineChart: react.NamedExoticComponent<Readonly<{
     }) => string;
 }>>;
 
+/**
+ * @deprecated Use the v2 component instead:
+ *
+ * ```ts
+ * import { VerticalBarChart } from "@sproutsocial/seeds-react-data-viz/bar";
+ * ```
+ *
+ * The v2 component is built on the shared chart base. See `charts/README.md`
+ * for the architecture. The v2 prop shape differs from this legacy component
+ * and v2 does not yet cover every legacy feature (locale-aware tooltips,
+ * formatters, interactions, annotations, legend). Use the Claude-assisted
+ * migration skill at
+ * `seeds-tooling/seeds-codemod-cli/src/usage-patterns/VERTICALBARCHARTV1_PATTERNS.md`
+ * — it documents the prop mapping and tells you when to wait rather than
+ * force-migrate.
+ */
 declare const VerticalBarChart: react.NamedExoticComponent<Readonly<{
     data: ReadonlyArray<Readonly<{
         name: string;
@@ -488,6 +441,11 @@ declare const xAxisLabelFormatter: ({ textLocale, tickPositions, unitName, value
  * Helper to detect if data is hourly time data (all x values are hours of the same day)
  * @param data - Array of series data with points containing x values
  * @returns boolean indicating if all x values are hours of the same day
+ * @deprecated Auto-detection of hourly data is deprecated. v2 is declarative:
+ * use `xAxis={{ type: "datetime", timeFormat: "12" | "24" }}` + a top-level
+ * `timezone` instead of relying on implicit detection. See
+ * `seeds-tooling/seeds-codemod-cli/src/usage-patterns/VERTICALBARCHARTV1_PATTERNS.md`
+ * (CE-8).
  */
 declare function isHourlyTimeData(data: ReadonlyArray<Readonly<{
     points: ReadonlyArray<{
@@ -500,6 +458,11 @@ declare function isHourlyTimeData(data: ReadonlyArray<Readonly<{
  * Supports both 12-hour format ("12 AM", "1 PM") and 24-hour format ("00:00", "13:00", "23:00")
  * @param data - Array of series data with points containing x values
  * @returns boolean indicating if all x values are hour strings
+ * @deprecated Auto-detection of hourly data is deprecated. v2 is declarative:
+ * use `xAxis={{ type: "datetime", timeFormat: "12" | "24" }}` + a top-level
+ * `timezone` instead of relying on implicit detection. See
+ * `seeds-tooling/seeds-codemod-cli/src/usage-patterns/VERTICALBARCHARTV1_PATTERNS.md`
+ * (CE-8).
  */
 declare function isCategoricalHourData(data: ReadonlyArray<Readonly<{
     points: ReadonlyArray<{
@@ -570,4 +533,4 @@ declare const donutChartStyles: styled_components.FlattenInterpolation<styled_co
     $hasOnClick: TypeChartStyleHasOnClick;
 }>, any>>;
 
-export { AreaChart, ChartLegend, ChartLegendLabel, ChartTable, ChartTooltip, ChartTooltipFooter, ChartTooltipHeader, ChartTooltipPortal, ChartTooltipTable, ChartTooltipTitle, ChartXAnnotationDetails, ChartXAnnotationMarker, ColorBox, DONUT_CHART_HALO_SIZE, DONUT_CHART_HEIGHT, DONUT_CHART_WIDTH, DatavizColorBox, DonutChart, DonutChartLegendTable, type ExtendedAxisLabelsFormatterContextObject, type ExtendedTimeTicksInfoObject, GlobalChartStyleOverrides, LineChart, NetworkColorBox, TIME_SERIES_CHART_HEIGHT, type TypeAreaChartProps, type TypeChartDataPoint, type TypeChartDataStyles, type TypeChartLegendLabelProps, type TypeChartLegendProps, type TypeChartNumberFormat, type TypeChartStyleColor, type TypeChartStyleHasOnClick, type TypeChartStylePattern, type TypeChartTableProps, type TypeChartTimeFormat, type TypeChartTooltipDateFormatter, type TypeChartTooltipProps, type TypeChartTooltipTableProps, type TypeChartXAnnotations, type TypeChartXAnnotationsDetails, type TypeChartYAxisLabelFormatter, type TypeColorBoxProps, type TypeDatavizColorBox, type TypeDatavizColorBoxProps, type TypeDonutChartDataItem, type TypeDonutChartLegendTableProps, type TypeDonutChartProps, type TypeDonutChartTooltipProps, type TypeExtendedChart, type TypeLegendLabel, type TypeLineChartProps, type TypeSeriesType, type TypeVerticalBarChartProps, VERTICAL_BAR_CHART_DEFAULT_SERIES_LIMIT, VerticalBarChart, areaChartOptions, areaChartStyles, baseChartOptions, baseChartStyles, columnChartOptions, donutChartOptions, donutChartStyles, generateChartTooltipPortalId, getDatavizColor, getDatavizColorWithAlpha, getDatavizOpacity, getStorybookCategoricalData, getStorybookSparseTimelineData, isCategoricalHourData, isHourlyTimeData, lineChartOptions, lineChartStyles, timeSeriesChartOptions, timeSeriesChartStyles, transformDataToSeries, transformTimeSeriesTooltipData, xAxisLabelFormatter, yAxisLabelFormatter };
+export { AreaChart, ChartLegend, ChartLegendLabel, ChartTable, ChartTooltip, ChartTooltipFooter, ChartTooltipHeader, ChartTooltipPortal, ChartTooltipTable, ChartTooltipTitle, ChartXAnnotationDetails, ChartXAnnotationMarker, ColorBox, DONUT_CHART_HALO_SIZE, DONUT_CHART_HEIGHT, DONUT_CHART_WIDTH, DatavizColorBox, DonutChart, DonutChartLegendTable, ExtendedTimeTicksInfoObject, GlobalChartStyleOverrides, LineChart, NetworkColorBox, TIME_SERIES_CHART_HEIGHT, type TypeAreaChartProps, TypeChartDataPoint, TypeChartDataStyles, type TypeChartLegendLabelProps, type TypeChartLegendProps, TypeChartNumberFormat, TypeChartStyleColor, TypeChartStyleHasOnClick, TypeChartStylePattern, type TypeChartTableProps, TypeChartTimeFormat, TypeChartTooltipDateFormatter, TypeChartTooltipProps, type TypeChartTooltipTableProps, TypeChartXAnnotations, TypeChartYAxisLabelFormatter, type TypeColorBoxProps, type TypeDatavizColorBox, type TypeDatavizColorBoxProps, type TypeDonutChartDataItem, type TypeDonutChartLegendTableProps, type TypeDonutChartProps, type TypeDonutChartTooltipProps, type TypeLegendLabel, type TypeLineChartProps, TypeSeriesType, TypeVerticalBarChartProps, VERTICAL_BAR_CHART_DEFAULT_SERIES_LIMIT, VerticalBarChart, areaChartOptions, areaChartStyles, baseChartOptions, baseChartStyles, columnChartOptions, donutChartOptions, donutChartStyles, generateChartTooltipPortalId, getDatavizColor, getDatavizColorWithAlpha, getDatavizOpacity, getStorybookCategoricalData, getStorybookSparseTimelineData, isCategoricalHourData, isHourlyTimeData, lineChartOptions, lineChartStyles, timeSeriesChartOptions, timeSeriesChartStyles, transformDataToSeries, transformTimeSeriesTooltipData, xAxisLabelFormatter, yAxisLabelFormatter };