solid-recharts 0.2.1 → 1.0.0

package/test/helper/expectStackGroups.ts

@@ -1,144 +0,0 @@
-// Ported from recharts 3.8.1 test/helper/expectStackGroups.ts (commit 7a23854).
-import { expect } from "vitest";
-import { StackDataPoint, StackSeries } from "../../src/util/stacks/stackTypes";
-import { MaybeStackedGraphicalItem } from "../../src/state/types/StackedGraphicalItem";
-
-interface SyncExpectationResult {
-  pass: boolean;
-  message: () => string;
-  actual?: unknown;
-  expected?: unknown;
-}
-
-export type ExpectedStackedDataSeries = ReadonlyArray<StackDataPoint>;
-
-/*
- * Almost the same type as StackData, but with the data
- * being just an array of arrays of objects instead of a d3-stack object.
- */
-export type ExpectedStackedData = ReadonlyArray<ExpectedStackedDataSeries>;
-
-function seriesPointToTuple(seriesPoint: StackDataPoint): StackDataPoint {
-  return [seriesPoint[0], seriesPoint[1]];
-}
-
-const actualSeriesToExpectedSeries = (
-  s: ReadonlyArray<StackDataPoint>,
-): ExpectedStackedDataSeries => {
-  const array: Array<StackDataPoint> = [];
-  s.forEach((item) => {
-    array.push(seriesPointToTuple(item));
-  });
-  return array;
-};
-
-function seriesToArray(series: ReadonlyArray<ReadonlyArray<StackDataPoint>>): ExpectedStackedData {
-  return series.map(actualSeriesToExpectedSeries);
-}
-
-/**
- * Comparing stack data for equality.
- * d3-stack adds static properties to arrays that confuse vitest's default matcher.
- */
-export function expectStackedData(
-  received: ExpectedStackedData,
-  expected: ExpectedStackedData,
-): void {
-  if (!Array.isArray(received)) {
-    throw new Error(`stackedData error: expected ${String(received)} to be an array`);
-  }
-  expect(seriesToArray(received)).toEqual(expected);
-}
-
-export function expectStackedSeries(
-  received: ExpectedStackedDataSeries,
-  expected: ExpectedStackedDataSeries,
-): void {
-  if (!Array.isArray(received)) {
-    throw new Error(`stackedSeries error: expected ${String(received)} to be an array`);
-  }
-  expect(actualSeriesToExpectedSeries(received)).toEqual(expected);
-}
-
-function rechartsStackedDataMatcher(
-  received: ExpectedStackedData,
-  expected: ExpectedStackedData,
-): SyncExpectationResult {
-  try {
-    expectStackedData(received, expected);
-    return {
-      pass: true,
-      message: () => "Expected stack groups to not match",
-    };
-  } catch (e) {
-    return {
-      pass: false,
-      message: () => (e instanceof Error ? e.message : String(e)),
-    };
-  }
-}
-
-function rechartsStackedSeriesMatcher(
-  received: ExpectedStackedDataSeries,
-  expected: ExpectedStackedDataSeries,
-): SyncExpectationResult {
-  try {
-    expectStackedSeries(received, expected);
-    return {
-      pass: true,
-      message: () => "Expected stack series to not match",
-    };
-  } catch (e) {
-    return {
-      pass: false,
-      message: () => (e instanceof Error ? e.message : String(e)),
-    };
-  }
-}
-
-function rechartsStackedSeriesPointMatcher(
-  received: StackDataPoint,
-  expected: StackDataPoint,
-): SyncExpectationResult {
-  try {
-    if (!Array.isArray(received)) {
-      throw new Error(`stackedSeriesPoint error: expected ${String(received)} to be an array`);
-    }
-    expect(seriesPointToTuple(received)).toEqual(expected);
-    return {
-      pass: true,
-      message: () => "Expected stack series point to not match",
-    };
-  } catch (e) {
-    return {
-      pass: false,
-      message: () => (e instanceof Error ? e.message : String(e)),
-    };
-  }
-}
-
-expect.extend({
-  toBeRechartsStackedData: rechartsStackedDataMatcher,
-  toBeRechartsStackedSeries: rechartsStackedSeriesMatcher,
-  toBeRechartsStackedSeriesPoint: rechartsStackedSeriesPointMatcher,
-});
-
-interface CustomMatchers {
-  toBeRechartsStackedData: (expectedStackedData: ExpectedStackedData) => ReadonlyArray<StackSeries>;
-  toBeRechartsStackedSeries: (expectedStackedSeries: ExpectedStackedDataSeries) => StackSeries;
-  toBeRechartsStackedSeriesPoint: (expectedStackedSeriesPoint: StackDataPoint) => StackDataPoint;
-}
-
-declare module "vitest" {
-  // eslint-disable-next-line @typescript-eslint/no-empty-object-type
-  interface AsymmetricMatchersContaining extends CustomMatchers {}
-}
-
-/**
- * Vitest helpers are typed to return `any` which disables type checking in the whole test if used.
- */
-export function expectGraphicalItemSettings(
-  expected: MaybeStackedGraphicalItem,
-): MaybeStackedGraphicalItem {
-  return expect.objectContaining(expected);
-}

package/test/helper/mockAxes.ts

@@ -1,22 +0,0 @@
-// Port of recharts 3.8.1 test/helper/mockAxes.ts (commit 7a23854).
-import { scaleLinear } from "d3-scale";
-import {
-  BaseAxisWithScale,
-  implicitXAxis,
-  implicitYAxis,
-} from "../../src/state/selectors/axisSelectors";
-import { rechartsScaleFactory, RechartsScale } from "../../src/util/scale/RechartsScale";
-
-export const mockScale: RechartsScale<number> = rechartsScaleFactory<number>(
-  scaleLinear().domain([0, 500]),
-);
-
-export const mockXAxisWithScale: BaseAxisWithScale = {
-  ...implicitXAxis,
-  scale: mockScale,
-};
-
-export const mockYAxisWithScale: BaseAxisWithScale = {
-  ...implicitYAxis,
-  scale: mockScale,
-};

package/test/helper/mockGetBoundingClientRect.ts

@@ -1,66 +0,0 @@
-// Ported from recharts 3.8.1 test/helper/mockGetBoundingClientRect.ts.
-// `getMockDomRect`, `mockGetBoundingClientRect`, and
-// `mockSequenceOfGetBoundingClientRect` are ported.
-import { vi } from "vitest";
-import { mockHTMLElementProperty } from "./mockHTMLElementProperty";
-
-type NonEmptyArray<T> = [T, ...T[]];
-
-export function getMockDomRect(partial: Partial<DOMRect> = {}): DOMRect {
-  return {
-    x: 0,
-    y: 0,
-    width: 0,
-    height: 0,
-    top: 0,
-    right: 0,
-    bottom: 0,
-    left: 0,
-    ...partial,
-    toJSON() {
-      JSON.stringify(this);
-    },
-  };
-}
-
-/**
- * getBoundingClientRect always returns 0 in jsdom, we can't test for actual returned string size.
- * Assumes vitest `restoreMocks` is on (no explicit cleanup available).
- *
- * @param rect overrides getBoundingClientRect return value in the mock
- * @param mockClientHeightWidth overrides offsetWidth/offsetHeight with the same values as rect
- */
-export function mockGetBoundingClientRect(
-  rect: Partial<DOMRect>,
-  mockClientHeightWidth = true,
-): void {
-  const mockDomRect = getMockDomRect(rect);
-  vi.spyOn(Element.prototype, "getBoundingClientRect").mockReturnValue(mockDomRect);
-
-  if (mockClientHeightWidth) {
-    mockHTMLElementProperty("offsetHeight", mockDomRect.height);
-    mockHTMLElementProperty("offsetWidth", mockDomRect.width);
-  }
-}
-
-/**
- * Like `mockGetBoundingClientRect`, but returns each rect in `rects` in order for
- * the first N-1 calls and the last rect for every subsequent call. Used to model
- * layout that measures a 0x0 element before it is sized (e.g. Legend bbox).
- */
-export function mockSequenceOfGetBoundingClientRect(
-  rects: NonEmptyArray<Partial<DOMRect>>,
-  mockClientHeightWidth = true,
-): void {
-  const mockDomRects = rects.map((r) => getMockDomRect(r));
-  const spy = vi.spyOn(Element.prototype, "getBoundingClientRect");
-  for (let i = 0; i < mockDomRects.length - 1; i++) {
-    spy.mockReturnValueOnce(mockDomRects[i]!);
-  }
-  spy.mockReturnValue(mockDomRects[mockDomRects.length - 1]!);
-
-  if (mockClientHeightWidth) {
-    mockHTMLElementProperty("offsetHeight", mockDomRects[0]!.height);
-    mockHTMLElementProperty("offsetWidth", mockDomRects[0]!.width);
-  }
-}

package/test/helper/mockHTMLElementProperty.ts

@@ -1,19 +0,0 @@
-// Ported verbatim from recharts 3.8.1 test/helper/mockHTMLElementProperty.ts.
-import { assertNotNull } from "./assertNotNull";
-
-const mocks: Array<() => void> = [];
-
-export function mockHTMLElementProperty(name: keyof HTMLElement, value: number) {
-  const original = Object.getOwnPropertyDescriptor(HTMLElement.prototype, name);
-  Object.defineProperty(HTMLElement.prototype, name, { configurable: true, value });
-  function cleanup() {
-    assertNotNull(original);
-    Object.defineProperty(HTMLElement.prototype, name, original);
-  }
-  mocks.push(cleanup);
-}
-
-export function restoreHTMLElementProperties() {
-  mocks.forEach((cleanup) => cleanup());
-  mocks.length = 0;
-}

package/test/helper/mockTouchingElement.ts

@@ -1,27 +0,0 @@
-// Ported from recharts 3.8.1 test/helper/mockTouchingElement.ts (commit 7a23854).
-import type { GraphicalItemId } from "../../src/state/graphicalItemsSlice";
-import type { TooltipIndex } from "../../src/state/tooltipSlice";
-import {
-  DATA_ITEM_GRAPHICAL_ITEM_ID_ATTRIBUTE_NAME,
-  DATA_ITEM_INDEX_ATTRIBUTE_NAME,
-} from "../../src/util/Constants";
-
-/**
- * Pretend the user is touching an element at the given index. jsdom does not
- * support elementFromPoint (no layout); recharts tests mock it for touchmove.
- */
-export function mockTouchingElement(
-  touchItemIndex: NonNullable<TooltipIndex>,
-  graphicalItemId: GraphicalItemId,
-): void {
-  const fakeElement = document.createElement("g");
-  fakeElement.setAttribute(DATA_ITEM_INDEX_ATTRIBUTE_NAME, String(touchItemIndex));
-  fakeElement.setAttribute(DATA_ITEM_GRAPHICAL_ITEM_ID_ATTRIBUTE_NAME, graphicalItemId);
-  document.elementFromPoint = () => fakeElement;
-}
-
-/** Mock touching an element that is not a chart data item. */
-export function mockTouchingUnrelatedElement(): void {
-  const fakeElement = document.createElement("g");
-  document.elementFromPoint = () => fakeElement;
-}

package/test/helper/offsetHelpers.ts

@@ -1,19 +0,0 @@
-// Ported verbatim from recharts 3.8.1 test/helper/offsetHelpers.ts.
-import { ChartOffsetInternal } from "../../src/util/types";
-
-export const emptyOffset: ChartOffsetInternal = {
-  top: 0,
-  bottom: 0,
-  left: 0,
-  right: 0,
-  width: 0,
-  height: 0,
-  brushBottom: 0,
-};
-
-export function makeChartOffset(partialOffset: Partial<ChartOffsetInternal>): ChartOffsetInternal {
-  return {
-    ...emptyOffset,
-    ...partialOffset,
-  };
-}

package/test/helper/parameterizedTestCases.tsx

@@ -1,99 +0,0 @@
-// Solid port of recharts 3.8.1 test/helper/parameterizedTestCases.tsx (commit 7a23854).
-// Minimal subset: BarChart + ComposedChart cases used by cartesian/Bar/Bar.spec.tsx.
-import type { JSX } from "@solidjs/web";
-import type { CartesianLayout, EventThrottlingProps } from "../../src/util/types";
-import { AreaChart, BarChart, ComposedChart, LineChart, Scatter, ScatterChart } from "../../src";
-import type { TooltipIndex } from "../../src/state/tooltipSlice";
-
-export type CartesianChartTestCase = {
-  ChartElement: (
-    props: {
-      children?: JSX.Element;
-      width?: number;
-      height?: number;
-      data?: unknown[];
-      layout?: CartesianLayout;
-      compact?: boolean;
-      class?: string;
-      onClick?: (param: unknown) => void;
-      onMouseEnter?: (param: unknown) => void;
-      onMouseMove?: (param: unknown) => void;
-      onMouseLeave?: (param: unknown) => void;
-      onTouchStart?: (param: unknown) => void;
-      onTouchMove?: (param: unknown) => void;
-      onTouchEnd?: (param: unknown) => void;
-    } & EventThrottlingProps,
-  ) => JSX.Element;
-  testName: string;
-  tooltipIndex: NonNullable<TooltipIndex>;
-};
-
-export const ComposedChartCase: CartesianChartTestCase = {
-  ChartElement: (props) => <ComposedChart width={500} height={500} {...props} />,
-  testName: "ComposedChart",
-  tooltipIndex: "0",
-};
-
-export const AreaChartCase: CartesianChartTestCase = {
-  ChartElement: (props) => <AreaChart width={500} height={500} {...props} />,
-  testName: "AreaChart",
-  tooltipIndex: "0",
-};
-
-export const LineChartCase: CartesianChartTestCase = {
-  ChartElement: (props) => <LineChart width={500} height={500} {...props} />,
-  testName: "LineChart",
-  tooltipIndex: "0",
-};
-
-export const BarChartCase: CartesianChartTestCase = {
-  ChartElement: (props) => <BarChart width={500} height={500} {...props} />,
-  testName: "BarChart",
-  tooltipIndex: "0",
-};
-
-export const ScatterChartCase: CartesianChartTestCase = {
-  ChartElement: (props) => (
-    <ScatterChart width={500} height={500} {...props}>
-      <Scatter />
-    </ScatterChart>
-  ),
-  testName: "ScatterChart",
-  tooltipIndex: "0",
-};
-
-// Bar.spec's matrix: ComposedChart accepts <Bar>, so the "must not render" set is
-// only the non-composed cartesian charts. Keep this list unchanged.
-const barMatrixChartCases: ReadonlyArray<CartesianChartTestCase> = [
-  ComposedChartCase,
-  BarChartCase,
-  ScatterChartCase,
-];
-
-// The full set of cartesian charts used by `allCartesianChartsExcept` (Area.spec's
-// render-gate matrix). Includes the dedicated AreaChart/LineChart cases.
-const allCartesianChartCases: ReadonlyArray<CartesianChartTestCase> = [
-  ComposedChartCase,
-  AreaChartCase,
-  LineChartCase,
-  BarChartCase,
-  ScatterChartCase,
-];
-
-/** Charts where `<Bar />` must not render rectangles (recharts Bar.spec matrix). */
-export function chartsWhereBarMustNotRender(
-  exceptions: ReadonlyArray<CartesianChartTestCase>,
-): ReadonlyArray<CartesianChartTestCase> {
-  return barMatrixChartCases.filter(
-    (testCase) => !exceptions.some((e) => e.testName === testCase.testName),
-  );
-}
-
-/** Cartesian charts EXCEPT the given exceptions (recharts allCartesianChartsExcept). */
-export function allCartesianChartsExcept(
-  exceptions: ReadonlyArray<CartesianChartTestCase>,
-): ReadonlyArray<CartesianChartTestCase> {
-  return allCartesianChartCases.filter(
-    (testCase) => !exceptions.some((e) => e.testName === testCase.testName),
-  );
-}

package/test/helper/produceState.ts

@@ -1,32 +0,0 @@
-/**
- * Solid-native port of the reference's immer-based `produceState` helper.
- *
- * The Solid rewrite has no immer dependency. Instead of `produce`, we snapshot a
- * fresh store's state to a plain value, deep-clone it into a mutable object that
- * PRESERVES functions (the state holds function values such as
- * `options.tooltipPayloadSearcher`, which `structuredClone` would throw on), run
- * the recipe (which mutates the draft in place), and return the mutated draft.
- */
-import { snapshot } from "solid-js";
-import { createRechartsStore, type RechartsRootState } from "../../src/state/store";
-
-function deepMutableClone<T>(value: T): T {
-  if (Array.isArray(value)) {
-    return value.map((v) => deepMutableClone(v)) as unknown as T;
-  }
-  if (value !== null && typeof value === "object") {
-    const out: Record<string, unknown> = {};
-    for (const k in value as Record<string, unknown>) {
-      out[k] = deepMutableClone((value as Record<string, unknown>)[k]);
-    }
-    return out as T;
-  }
-  // primitives AND functions are kept by reference
-  return value;
-}
-
-export function produceState(recipe: (draft: RechartsRootState) => void): RechartsRootState {
-  const base = deepMutableClone(snapshot(createRechartsStore().state));
-  recipe(base);
-  return base;
-}

package/test/helper/selectorTestHelpers.tsx

@@ -1,63 +0,0 @@
-// Solid-native, value-only port of recharts 3.8.1 test/helper/selectorTestHelpers.tsx.
-//
-// recharts' originals also assert reselect REFERENCE stability (`toBe`):
-// `shouldReturnFromInitialState` re-runs the selector on the same state and asserts
-// the result is the identical object, and `assertStableBetweenRenders` /
-// `useAppSelectorWithStableTest` exist purely for that. This port is Solid-native
-// with NO reselect (see the state-architecture-decision memory): selectors return
-// fresh objects each call and stability is handled by fine-grained reactivity, not
-// selector memoization. So the `toBe` stability assertions are genuinely N/A here
-// and are intentionally omitted — only the VALUE assertions (`toEqual`) are ported.
-import { describe, expect, it, vi } from "vitest";
-import { createRechartsStore } from "../../src/state/store";
-import type { RechartsRootState } from "../../src/state/store";
-import { useAppSelector } from "../../src/state/hooks";
-import { render } from "@solidjs/testing-library";
-import { flush, type Accessor } from "solid-js";
-
-type Selector<T> = (state: RechartsRootState) => T;
-
-/**
- * Solid analogue of recharts' `useAppSelectorWithStableTest`. recharts ran the
- * selector twice and asserted reselect reference stability (`toBe`); that is N/A
- * in this no-reselect Solid rewrite, so this is just `useAppSelector` — it returns
- * an `Accessor`, so callers read `result()` (recharts returned the bare value).
- */
-export function useAppSelectorWithStableTest<T>(selector: Selector<T>): Accessor<T | undefined> {
-  return useAppSelector(selector);
-}
-
-/**
- * Outside a chart's store context, `useAppSelector` yields `undefined` (and must
- * never throw). Mirrors recharts' "called out of Recharts context" guarantee.
- */
-export function shouldReturnUndefinedOutOfContext<T>(selector: Selector<T>): void {
-  it("should return undefined when called out of Recharts context", () => {
-    const spy = vi.fn();
-    const Comp = () => {
-      // No store provider in scope → the accessor resolves to undefined.
-      spy(useAppSelector(selector)());
-      return null;
-    };
-    render(() => <Comp />);
-    flush();
-    expect(spy).toHaveBeenCalledWith(undefined);
-  });
-}
-
-/**
- * The value a selector produces from a freshly created store (initial state).
- * Ported from recharts minus the `toBe` reference-stability assertion (N/A — see
- * the file header).
- */
-export function shouldReturnFromInitialState<T>(selector: Selector<T>, expectedReturn: T): void {
-  const valueDescription = JSON.stringify(expectedReturn);
-  it(`should return ${valueDescription} when called with initial state`, () => {
-    const store = createRechartsStore();
-    const result = selector(store.state);
-    expect(result).toEqual(expectedReturn);
-  });
-}
-
-// Re-export so spec files can group the shared assertions under a describe if needed.
-export { describe };

package/test/helper/trim.spec.ts

@@ -1,35 +0,0 @@
-import { describe, it, expect } from "vitest";
-import { trim } from "./trim";
-
-describe("trim", () => {
-  it("should return null when passed null", () => {
-    expect(trim(null)).toBe(null);
-    expect(trim(undefined)).toBe(undefined);
-  });
-
-  it("should return string as-is if it has no whitespace or only one space", () => {
-    expect(trim("")).toBe("");
-    expect(trim("foo")).toBe("foo");
-    expect(trim("foo bar")).toBe("foo bar");
-  });
-
-  it("should trim starting and ending spaces", () => {
-    expect(trim(" foo ")).toBe("foo");
-    expect(trim("foo ")).toBe("foo");
-    expect(trim(" foo")).toBe("foo");
-  });
-
-  it("should trim double spaces inside the string", () => {
-    expect(trim("foo  bar")).toBe("foo bar");
-    expect(trim("foo        bar")).toBe("foo bar");
-  });
-
-  it("should trim newlines and indentation", () => {
-    expect(
-      trim(`foo
-             foo
-                 foo
-       bar`),
-    ).toBe("foo foo foo bar");
-  });
-});

package/test/helper/trim.ts

@@ -1,11 +0,0 @@
-// Ported from recharts 3.8.1 test/helper/trim.ts.
-/**
- * Trims a path `d` attribute for whitespace-insensitive comparison (the SVG spec
- * is whitespace-insensitive but vitest's comparator is not).
- */
-export function trim(str: string | null | undefined): string | null | undefined {
-  if (typeof str !== "string") {
-    return str;
-  }
-  return str.replace(/^\s*/, "").replace(/\s*$/, "").replace(/\s+/g, " ");
-}