@automattic/charts 2.0.1 → 3.0.0

package/src/index.ts

@@ -32,6 +32,8 @@ export {
 	useGlobalChartsTheme,
 	GlobalChartsContext,
 	defaultTheme,
+	useChartScopeElement,
+	useChartRegistration,
 } from './providers';
 
 // Types - explicit exports (excludes internal types like DataPointPercentageCalculated)
@@ -60,7 +62,6 @@ export type {
 	ChartLegendConfig,
 	SeriesChartLegendConfig,
 	BaseChartProps,
-	GridProps,
 	GoogleDataTableColumn,
 	GoogleDataTableColumnRoleType,
 	GoogleDataTableRow,
@@ -122,6 +123,12 @@ export type { ArcData } from './charts/pie-semi-circle-chart';
 export type { SparklineProps, GradientConfig, SparklineDataPoint } from './charts/sparkline';
 
 // Utilities
-export { parseAsLocalDate, formatMetricValue, formatPercentage, mergeThemes } from './utils';
+export {
+	parseAsLocalDate,
+	formatMetricValue,
+	formatPercentage,
+	mergeThemes,
+	resolveCssVariable,
+} from './utils';
 export * from './utils/color-utils';
 export type { MetricValueType } from './utils';

package/src/providers/chart-context/global-charts-provider.tsx

@@ -8,6 +8,11 @@ import {
 	useLayoutEffect,
 	useRef,
 } from 'react';
+// Side-effect import: emits the `--a8c-charts-*` catalog, scoped to the `a8c-charts-scope` class applied to this component's wrapper below. Every chart either sits under a `GlobalChartsProvider` or auto-mounts its own, so importing it here guarantees the catalog always reaches the bundle.
+//
+// This must be a direct import of the stylesheet, not through a re-export barrel: a barrel `.ts` file doesn't match this package's `sideEffects` glob (only `*.css`/`*.scss` do), so tsdown/Rolldown treats an unused barrel import as side-effect-free and drops it — taking the nested stylesheet import with it. The file also can't be named `*.module.scss`: it declares zero CSS-module class names (only a `:where()`-wrapped selector), and `@tsdown/css` marks a `.module.*` file's generated JS proxy `moduleSideEffects: false` (tree-shakeable unless a class name is read); a plain stylesheet gets `moduleSideEffects: "no-treeshake"` instead, so it always ships. `tools/assert-charts-scope-emitted.ts` fails `pnpm run build` if this regresses — a passing test suite alone does not catch a dropped stylesheet.
+import '../../styles/chart-scope.scss';
+import { CHART_SCOPE_CLASS } from '../../styles/chart-scope-class';
 import {
 	getItemShapeStyles,
 	getSeriesBarStyles,
@@ -16,11 +21,15 @@ import {
 	resolveCssVariable,
 	normalizeColorToHex,
 } from '../../utils';
+// Imported from the module rather than the `chart-scope` barrel: the barrel also pulls `use-standalone-scope-class`, which imports `GlobalChartsContext` back from this file. That cycle resolves today only because the binding is read lazily inside the hook body.
+import { ChartScopeContext } from '../chart-scope/chart-scope-context';
 import { getChartColor, type ColorCache } from './private/get-chart-color';
+import { themeOverrideVars } from './private/theme-override-vars';
+import { withCatalogPointers } from './private/with-catalog-pointers';
 import { defaultTheme } from './themes';
 import type { GlobalChartsContextValue, ChartRegistration } from './types';
 import type { ChartTheme, CompleteChartTheme } from '../../types';
-import type { FC, ReactNode } from 'react';
+import type { CSSProperties, FC, ReactNode } from 'react';
 
 export const GlobalChartsContext = createContext< GlobalChartsContextValue | null >( null );
 
@@ -38,10 +47,26 @@ export const GlobalChartsProvider: FC< GlobalChartsProviderProps > = ( { childre
 
 	// Ref to the wrapper element for resolving scoped CSS variables
 	const wrapperRef = useRef< HTMLDivElement >( null );
+	const [ scopeNode, setScopeNode ] = useState< HTMLElement | null >( null );
+
+	const setWrapperNode = useCallback( ( node: HTMLDivElement | null ) => {
+		wrapperRef.current = node;
+		setScopeNode( node );
+	}, [] );
+
+	// themeOverrideVars reads the raw `theme` prop, never `providerTheme` — feeding it the restored theme below would make an overridden role's pointer look like a self-reference and drop the var (see themeOverrideVars' own doc comment).
+	const { vars: overrideVars, roles: overriddenRoles } = useMemo(
+		() => themeOverrideVars( theme ),
+		[ theme ]
+	);
 
 	const providerTheme: CompleteChartTheme = useMemo( () => {
-		return theme ? mergeThemes( defaultTheme, theme ) : defaultTheme;
-	}, [ theme ] );
+		if ( ! theme ) {
+			return defaultTheme;
+		}
+
+		return withCatalogPointers( mergeThemes( defaultTheme, theme ), overriddenRoles );
+	}, [ theme, overriddenRoles ] );
 
 	// Cache expensive color computations that only change when theme colors change
 	// Using useState + useLayoutEffect instead of useMemo to ensure CSS variables
@@ -186,11 +211,6 @@ export const GlobalChartsProvider: FC< GlobalChartsProviderProps > = ( { childre
 		[ colorCache, groupToColorMap ]
 	);
 
-	const resolveThemeColor = useCallback< GlobalChartsContextValue[ 'resolveThemeColor' ] >(
-		value => ( value ? normalizeColorToHex( value, wrapperRef.current, resolveCssVariable ) : '' ),
-		[]
-	);
-
 	const getElementStyles = useCallback< GlobalChartsContextValue[ 'getElementStyles' ] >(
 		( { data, index, overrideColor, legendShape } ) => {
 			const isSeriesData = data && typeof data === 'object' && 'data' in data && 'options' in data;
@@ -269,7 +289,6 @@ export const GlobalChartsProvider: FC< GlobalChartsProviderProps > = ( { childre
 			getChartData,
 			theme: providerTheme,
 			getElementStyles,
-			resolveThemeColor,
 			toggleSeriesVisibility,
 			isSeriesVisible,
 			getHiddenSeries,
@@ -282,7 +301,6 @@ export const GlobalChartsProvider: FC< GlobalChartsProviderProps > = ( { childre
 			getChartData,
 			providerTheme,
 			getElementStyles,
-			resolveThemeColor,
 			toggleSeriesVisibility,
 			isSeriesVisible,
 			getHiddenSeries,
@@ -292,8 +310,13 @@ export const GlobalChartsProvider: FC< GlobalChartsProviderProps > = ( { childre
 
 	return (
 		<GlobalChartsContext.Provider value={ value }>
-			<div ref={ wrapperRef } style={ { display: 'contents' } }>
-				{ children }
+			<div
+				ref={ setWrapperNode }
+				className={ CHART_SCOPE_CLASS }
+				data-testid="charts-scope"
+				style={ { display: 'contents', ...overrideVars } as CSSProperties }
+			>
+				<ChartScopeContext.Provider value={ scopeNode }>{ children }</ChartScopeContext.Provider>
 			</div>
 		</GlobalChartsContext.Provider>
 	);

package/src/providers/chart-context/private/theme-override-vars.ts

@@ -0,0 +1,87 @@
+import type { ChartTheme } from '../../../types';
+
+// The consumer theme fields that correspond to an emitted catalog role, and the role each one overrides. Each role must be read by exactly the elements its field controlled before the role existed: `svgLabelSmall.fill` maps to the narrow `--a8c-charts-color-label-axis` rather than `--a8c-charts-color-label`, because the broad role is also read by legend labels, heatmap cell values, funnel labels and the line-chart tooltip, which that field never moved.
+const ROLE_FOR_FIELD: Array< [ string, ( theme: Partial< ChartTheme > ) => string | undefined ] > =
+	[
+		[ '--a8c-charts-color-background', theme => theme.backgroundColor ],
+		[ '--a8c-charts-color-grid', theme => theme.gridStyles?.stroke ],
+		[ '--a8c-charts-color-axis', theme => theme.xAxisLineStyles?.stroke ],
+		[ '--a8c-charts-color-tick', theme => theme.xTickLineStyles?.stroke ],
+		[ '--a8c-charts-color-label-axis', theme => theme.svgLabelSmall?.fill ],
+	];
+
+/**
+ * The variable a `theme` prop override is published as, one layer outside the role itself.
+ *
+ * `chart-scope.scss` declares each of these roles as `var(<role>-theme, <catalog default>)`, so an override that is invalid at computed-value time — a fallback-less `var()` naming a token the host never set — only invalidates this variable, and the role still resolves its mapped `--wpds-*` token. Published as the role directly, such a value took the role and every bare `var(<role>)` read site down with it.
+ *
+ * @param role - The catalog role being overridden.
+ * @return The custom property carrying the consumer's value.
+ */
+export const themeLayerVar = ( role: string ): string => `${ role }-theme`;
+
+/** Every role whose catalog entry must read a theme layer. `src/styles/test/chart-scope.test.ts` checks the stylesheet against this. */
+export const THEME_LAYERED_ROLES: readonly string[] = ROLE_FOR_FIELD.map( ( [ role ] ) => role );
+
+/**
+ * Whether a value reads the role it is being published for, which would make the catalog entry depend on itself.
+ *
+ * The dependency runs `<role>: var(<role>-theme, …)`, so a value naming `<role>` closes a cycle through the catalog entry. CSS marks every custom property in a cycle invalid at computed-value time — the role's own fallback is *not* used, so the token resolves to nothing and every chart loses that colour. Verified in Chrome: `--role-theme: var(--role, blue); --role: var(--role-theme, green)` leaves `--role` empty, not `green`.
+ *
+ * Three things this has to get right, none of which a plain substring test gets:
+ *
+ * `var()` permits whitespace after the opening paren, so testing for `var(<role>` misses `var( --a8c-charts-color-grid, … )`.
+ *
+ * Several roles are prefixes of others (`--a8c-charts-color-label` of `--a8c-charts-color-label-secondary`), and every role is a prefix of its own theme layer. A prefix match would read a legitimate cross-role pointer as a self-reference and silently drop the override, so the role must be followed by something that cannot continue an identifier — `-` included. A value naming `<role>-theme` is therefore not treated as a self-reference: that cycle is confined to the theme layer, which leaves the role free to fall back to the catalog default.
+ *
+ * `resolveCssVariable` also accepts a bare custom-property name with no `var()` wrapper (`--a8c-charts-color-grid`), so that is legal `theme` input too. It forms no cycle — custom properties accept arbitrary token streams — so it survives as a literal string and drops silently at the use site instead of falling back to the catalog default.
+ *
+ * @param value - The consumer's value for the field.
+ * @param role  - The catalog role this value would override.
+ * @return True when the value reads `role`, so it must not be published.
+ */
+const readsOwnRole = ( value: string, role: string ): boolean =>
+	value.trim() === role ||
+	new RegExp( `var\\(\\s*${ role.replace( /[.*+?^${}()|[\]\\]/g, '\\$&' ) }(?![\\w-])` ).test(
+		value
+	);
+
+export type ThemeOverrides = {
+	/** The custom properties to write on the provider wrapper. */
+	vars: Record< string, string >;
+	/** Every mapped role the consumer set a value for, whether or not it was published. */
+	roles: readonly string[];
+};
+
+/**
+ * Maps a sparse consumer theme onto the theme-layer variables its overridden catalog roles read, so CSS-painted and JS-resolved colours read one source.
+ *
+ * A value that reads the role it would override is left unpublished — that is the default theme's own pointer surviving `mergeThemes`, and publishing it would invalidate the role. The role is still reported in `roles`: `withCatalogPointers` restores its theme field to the catalog pointer either way, so CSS and visx agree on the catalog default rather than visx painting a literal CSS never sees.
+ *
+ * @param theme - The consumer's `theme` prop, before merging with the default theme.
+ * @return The wrapper's custom properties, and the roles the consumer overrode.
+ */
+export const themeOverrideVars = ( theme?: Partial< ChartTheme > ): ThemeOverrides => {
+	if ( ! theme ) {
+		return { vars: {}, roles: [] };
+	}
+
+	const vars: Record< string, string > = {};
+	const roles: string[] = [];
+
+	for ( const [ role, read ] of ROLE_FOR_FIELD ) {
+		const value = read( theme );
+
+		if ( typeof value !== 'string' || value === '' ) {
+			continue;
+		}
+
+		roles.push( role );
+
+		if ( ! readsOwnRole( value, role ) ) {
+			vars[ themeLayerVar( role ) ] = value;
+		}
+	}
+
+	return { vars, roles };
+};

package/src/providers/chart-context/private/with-catalog-pointers.ts

@@ -0,0 +1,50 @@
+import { defaultTheme } from '../themes';
+import type { CompleteChartTheme } from '../../../types';
+
+// Restores each overridden role's mapped theme field to the catalog pointer `defaultTheme` already carries for it, so the value comes from `themes.ts` itself rather than a second, hand-copied literal.
+const CATALOG_RESTORE_FOR_ROLE: Record<
+	string,
+	( theme: CompleteChartTheme ) => Partial< CompleteChartTheme >
+> = {
+	'--a8c-charts-color-background': () => ( { backgroundColor: defaultTheme.backgroundColor } ),
+	'--a8c-charts-color-grid': theme => ( {
+		gridStyles: { ...theme.gridStyles, stroke: defaultTheme.gridStyles.stroke },
+	} ),
+	'--a8c-charts-color-axis': theme => ( {
+		xAxisLineStyles: { ...theme.xAxisLineStyles, stroke: defaultTheme.xAxisLineStyles.stroke },
+	} ),
+	'--a8c-charts-color-tick': theme => ( {
+		xTickLineStyles: { ...theme.xTickLineStyles, stroke: defaultTheme.xTickLineStyles.stroke },
+	} ),
+	'--a8c-charts-color-label-axis': theme => ( {
+		svgLabelSmall: { ...theme.svgLabelSmall, fill: defaultTheme.svgLabelSmall.fill },
+	} ),
+};
+
+/**
+ * Restores the mapped theme fields of `overriddenRoles` to their catalog pointer, so the theme-layer variable `themeOverrideVars` writes on the provider wrapper is the only carrier for an overridden role — CSS and the JS bridge (`useXYChartTheme`) then resolve it through the same cascade instead of visx reading a baked literal that can disagree with a closer CSS override.
+ *
+ * This covers roles `themeOverrideVars` deliberately left unpublished as well as the ones it published. A value that reads its own role is not publishable, but leaving visx the consumer's literal is what the whole mechanism exists to prevent: `theme={ { gridStyles: { stroke: 'var(--brand, var(--a8c-charts-color-grid, red))' } } }` would have CSS paint the catalog default while visx painted `--brand`.
+ *
+ * Every field outside the five mapped roles is left exactly as `merged` provided it: those aren't published as theme-layer vars, so rewriting them would erase a consumer's override with no replacement carrier.
+ *
+ * @param merged          - The consumer theme merged onto `defaultTheme` (`mergeThemes` output).
+ * @param overriddenRoles - The catalog roles the consumer overrode, from `themeOverrideVars`.
+ * @return A new theme object; `merged` is not mutated.
+ */
+export const withCatalogPointers = (
+	merged: CompleteChartTheme,
+	overriddenRoles: readonly string[]
+): CompleteChartTheme => {
+	let result = merged;
+
+	for ( const role of overriddenRoles ) {
+		const restore = CATALOG_RESTORE_FOR_ROLE[ role ];
+
+		if ( restore ) {
+			result = { ...result, ...restore( result ) };
+		}
+	}
+
+	return result;
+};

package/src/providers/chart-context/test/chart-context.test.tsx

@@ -2536,46 +2536,6 @@ describe( 'ChartContext', () => {
 				expect( afterRerenderColor ).toBe( '#ff0000' );
 			} );
 		} );
-
-		describe( 'resolveThemeColor', () => {
-			let contextValue: GlobalChartsContextValue;
-
-			const TestComponent = () => {
-				contextValue = useGlobalChartsContext();
-				return <div>Test</div>;
-			};
-
-			const mountProvider = () =>
-				render(
-					<GlobalChartsProvider>
-						<TestComponent />
-					</GlobalChartsProvider>
-				);
-
-			it( 'resolves a CSS variable against the provider scope, not the document root', () => {
-				window.getComputedStyle = jest.fn( ( element: Element ) => ( {
-					getPropertyValue: ( prop: string ) =>
-						prop === '--surface' && element !== document.documentElement ? '#1e1e1e' : '#ffffff',
-				} ) ) as unknown as typeof window.getComputedStyle;
-
-				mountProvider();
-
-				expect( contextValue.resolveThemeColor( 'var(--surface, #fff)' ) ).toBe( '#1e1e1e' );
-			} );
-
-			it( 'passes a resolved color through to hex', () => {
-				mountProvider();
-
-				expect( contextValue.resolveThemeColor( '#abcdef' ) ).toBe( '#abcdef' );
-				expect( contextValue.resolveThemeColor( 'rgb(255, 0, 0)' ) ).toBe( '#ff0000' );
-			} );
-
-			it( 'returns an empty string for an empty value', () => {
-				mountProvider();
-
-				expect( contextValue.resolveThemeColor( '' ) ).toBe( '' );
-			} );
-		} );
 	} );
 
 	describe( 'defaultTheme', () => {

package/src/providers/chart-context/test/chart-scope-class.test.tsx

@@ -0,0 +1,19 @@
+import { render, screen } from '@testing-library/react';
+import { CHART_SCOPE_CLASS } from '../../../styles/chart-scope-class';
+import { GlobalChartsProvider } from '../global-charts-provider';
+
+describe( 'GlobalChartsProvider wrapper', () => {
+	it( 'carries the a8c-charts-scope class and nothing that affects layout', () => {
+		render(
+			<GlobalChartsProvider>
+				<div>child</div>
+			</GlobalChartsProvider>
+		);
+
+		const wrapper = screen.getByTestId( 'charts-scope' );
+
+		expect( wrapper ).toHaveClass( CHART_SCOPE_CLASS );
+		// The catalog needs an element to sit on; `display: contents` is what keeps that element out of the consumer's layout.
+		expect( wrapper.style.cssText.replace( /\s/g, '' ) ).toBe( 'display:contents;' );
+	} );
+} );

package/src/providers/chart-context/test/sparse-theme.test.ts

@@ -0,0 +1,35 @@
+import { defaultTheme } from '../themes';
+
+const flatten = ( value: unknown ): string[] => {
+	if ( typeof value === 'string' ) {
+		return [ value ];
+	}
+	if ( Array.isArray( value ) ) {
+		return value.flatMap( flatten );
+	}
+	if ( value && typeof value === 'object' ) {
+		return Object.values( value ).flatMap( flatten );
+	}
+	return [];
+};
+
+describe( 'defaultTheme', () => {
+	const strings = flatten( defaultTheme );
+
+	it( 'holds no --wpds-* mapping — that lives only in the catalog stylesheet', () => {
+		expect( strings.filter( value => value.includes( '--wpds-' ) ) ).toEqual( [] );
+	} );
+
+	it( 'points every themed colour at an --a8c-charts-* catalog role', () => {
+		const varStrings = strings.filter( value => value.startsWith( 'var(' ) );
+
+		expect( varStrings.length ).toBeGreaterThan( 0 );
+		expect( varStrings.every( value => value.startsWith( 'var(--a8c-charts-' ) ) ).toBe( true );
+	} );
+
+	it( 'gives every catalog pointer a terminal literal for the SSR and jsdom paths', () => {
+		const varStrings = strings.filter( value => value.startsWith( 'var(--a8c-charts-' ) );
+
+		expect( varStrings.every( value => value.includes( ',' ) ) ).toBe( true );
+	} );
+} );

package/src/providers/chart-context/test/theme-override-vars-guard.test.tsx

@@ -0,0 +1,29 @@
+import { render, screen } from '@testing-library/react';
+import { GlobalChartsProvider } from '../global-charts-provider';
+
+// The stock defaultTheme's mapped fields are themselves self-referential pointers (e.g. `gridStyles.stroke: 'var(--a8c-charts-color-grid, #dbdbdb)'`), so themeOverrideVars' own self-reference guard already filters them out no matter which theme object the provider passes in. That makes "reads theme, not providerTheme" unfalsifiable against the real default theme. Mocking the default here to a plain, non-pointer value removes that overlap, so this test only passes when the provider reads the raw consumer `theme` prop rather than the merged `providerTheme`.
+jest.mock( '../themes', () => {
+	const actual = jest.requireActual( '../themes' );
+	return {
+		...actual,
+		defaultTheme: {
+			...actual.defaultTheme,
+			gridStyles: { ...actual.defaultTheme.gridStyles, stroke: '#dbdbdb' },
+		},
+	};
+} );
+
+describe( 'GlobalChartsProvider wrapper style (discriminating guard test)', () => {
+	it( 'does not emit an instance override for a role the consumer left unset, even though the merged theme carries a concrete default value', () => {
+		render(
+			<GlobalChartsProvider theme={ { tickLength: 8 } }>
+				<div>child</div>
+			</GlobalChartsProvider>
+		);
+
+		const wrapper = screen.getByTestId( 'charts-scope' );
+
+		expect( wrapper.style.getPropertyValue( '--a8c-charts-color-grid-theme' ) ).toBe( '' );
+		expect( wrapper.style.getPropertyValue( '--a8c-charts-color-grid' ) ).toBe( '' );
+	} );
+} );

package/src/providers/chart-context/test/theme-override-vars.test.ts

@@ -0,0 +1,118 @@
+import {
+	THEME_LAYERED_ROLES,
+	themeLayerVar,
+	themeOverrideVars,
+} from '../private/theme-override-vars';
+
+describe( 'themeOverrideVars', () => {
+	it( 'returns nothing for an absent theme', () => {
+		expect( themeOverrideVars( undefined ) ).toEqual( { vars: {}, roles: [] } );
+	} );
+
+	it( 'returns nothing for a theme that overrides no mapped role', () => {
+		expect( themeOverrideVars( { tickLength: 8 } ) ).toEqual( { vars: {}, roles: [] } );
+	} );
+
+	// The value is published one layer outside the role — `chart-scope.scss` declares the role as `var(<role>-theme, <catalog default>)`. Published as the role itself, a value that is invalid at computed-value time (`var(--wpds-token)` with the token unset) would make the role invalid too, and every bare `var(--a8c-charts-color-grid)` read site would paint `unset` instead of falling back to the catalog default.
+	it( 'maps a grid stroke override onto the grid role’s theme layer', () => {
+		expect( themeOverrideVars( { gridStyles: { stroke: 'red' } } ) ).toEqual( {
+			vars: { '--a8c-charts-color-grid-theme': 'red' },
+			roles: [ '--a8c-charts-color-grid' ],
+		} );
+	} );
+
+	it( 'maps every supported role at once', () => {
+		expect(
+			themeOverrideVars( {
+				backgroundColor: '#111',
+				gridStyles: { stroke: '#222' },
+				xAxisLineStyles: { stroke: '#333' },
+				xTickLineStyles: { stroke: '#444' },
+				svgLabelSmall: { fill: '#555' },
+			} )
+		).toEqual( {
+			vars: {
+				'--a8c-charts-color-background-theme': '#111',
+				'--a8c-charts-color-grid-theme': '#222',
+				'--a8c-charts-color-axis-theme': '#333',
+				'--a8c-charts-color-tick-theme': '#444',
+				'--a8c-charts-color-label-axis-theme': '#555',
+			},
+			roles: [
+				'--a8c-charts-color-background',
+				'--a8c-charts-color-grid',
+				'--a8c-charts-color-axis',
+				'--a8c-charts-color-tick',
+				'--a8c-charts-color-label-axis',
+			],
+		} );
+	} );
+
+	it( 'publishes only theme-layer variables, never a catalog role directly', () => {
+		const { vars } = themeOverrideVars( {
+			backgroundColor: '#111',
+			gridStyles: { stroke: '#222' },
+			xAxisLineStyles: { stroke: '#333' },
+			xTickLineStyles: { stroke: '#444' },
+			svgLabelSmall: { fill: '#555' },
+		} );
+
+		expect( Object.keys( vars ) ).toEqual( THEME_LAYERED_ROLES.map( themeLayerVar ) );
+	} );
+
+	// The narrow role is the whole point: the broad `--a8c-charts-color-label` is also read by legend labels, heatmap cell values, funnel labels and the line-chart tooltip, none of which `svgLabelSmall.fill` moved before the role was published as a custom property.
+	it( 'publishes an svg label override as the narrow axis-label role, not the broad one', () => {
+		expect( themeOverrideVars( { svgLabelSmall: { fill: 'red' } } ) ).toEqual( {
+			vars: { '--a8c-charts-color-label-axis-theme': 'red' },
+			roles: [ '--a8c-charts-color-label-axis' ],
+		} );
+	} );
+
+	it( 'ignores a value that is itself a pointer at the role it would override', () => {
+		expect(
+			themeOverrideVars( { gridStyles: { stroke: 'var(--a8c-charts-color-grid, #dbdbdb)' } } ).vars
+		).toEqual( {} );
+	} );
+
+	// A skipped value still reports its role, so `withCatalogPointers` restores the theme field. Without that, CSS would paint the catalog default while visx painted the consumer's literal — the divergence this whole mechanism exists to remove.
+	it( 'still reports the role of a value it refuses to publish', () => {
+		expect(
+			themeOverrideVars( {
+				gridStyles: { stroke: 'var(--brand, var(--a8c-charts-color-grid, red))' },
+			} )
+		).toEqual( { vars: {}, roles: [ '--a8c-charts-color-grid' ] } );
+	} );
+
+	// `var()` allows whitespace after the opening paren. The role reads its theme layer, so a value naming the role closes a cycle through the catalog entry: CSS marks every custom property in a cycle invalid at computed-value time, and the role's own fallback is not used, so the token resolves to nothing at all.
+	it( 'ignores a self-referential pointer padded with whitespace', () => {
+		expect(
+			themeOverrideVars( { gridStyles: { stroke: 'var( --a8c-charts-color-grid, #dbdbdb )' } } )
+				.vars
+		).toEqual( {} );
+	} );
+
+	it( 'still emits a value that merely mentions a different role', () => {
+		expect(
+			themeOverrideVars( { gridStyles: { stroke: 'var( --a8c-charts-color-axis, #dbdbdb )' } } )
+				.vars
+		).toEqual( {
+			'--a8c-charts-color-grid-theme': 'var( --a8c-charts-color-axis, #dbdbdb )',
+		} );
+	} );
+
+	// A mapped role can be a strict prefix of another custom property — a catalog role such as `--a8c-charts-color-label` of `--a8c-charts-color-label-axis`, the role's own theme layer, or a name the consumer defined themselves. A prefix match would read a legitimate cross-property pointer as a self-reference and silently drop the override, so the role must be followed by something that cannot continue an identifier.
+	it( 'does not mistake a longer property name for the role it guards', () => {
+		expect(
+			themeOverrideVars( {
+				xAxisLineStyles: { stroke: 'var(--a8c-charts-color-axis-emphasis, #000)' },
+			} ).vars
+		).toEqual( { '--a8c-charts-color-axis-theme': 'var(--a8c-charts-color-axis-emphasis, #000)' } );
+	} );
+
+	// `resolveCssVariable` also accepts a bare custom-property name with no `var()` wrapper, so `theme={ { gridStyles: { stroke: '--a8c-charts-color-grid' } } }` is legal input. It forms no cycle, so it must be caught explicitly or it survives as a literal string value and drops silently at the use site.
+	it( 'ignores a self-referential pointer written as a bare custom-property name', () => {
+		expect(
+			themeOverrideVars( { gridStyles: { stroke: '--a8c-charts-color-grid' } } ).vars
+		).toEqual( {} );
+	} );
+} );

package/src/providers/chart-context/test/with-catalog-pointers.test.ts

@@ -0,0 +1,47 @@
+import { mergeThemes } from '../../../utils';
+import { withCatalogPointers } from '../private/with-catalog-pointers';
+import { defaultTheme } from '../themes';
+import type { ChartTheme } from '../../../types';
+
+describe( 'withCatalogPointers', () => {
+	it( 'restores every overridden role to its catalog pointer, without mutating the input theme', () => {
+		const merged = mergeThemes( defaultTheme, {
+			backgroundColor: '#111',
+			gridStyles: { stroke: '#222' },
+			xAxisLineStyles: { stroke: '#333' },
+			xTickLineStyles: { stroke: '#444' },
+			svgLabelSmall: { fill: '#555' },
+		} as Partial< ChartTheme > );
+
+		const result = withCatalogPointers( merged, [
+			'--a8c-charts-color-background',
+			'--a8c-charts-color-grid',
+			'--a8c-charts-color-axis',
+			'--a8c-charts-color-tick',
+			'--a8c-charts-color-label-axis',
+		] );
+
+		expect( result.backgroundColor ).toBe( defaultTheme.backgroundColor );
+		expect( result.gridStyles.stroke ).toBe( defaultTheme.gridStyles.stroke );
+		expect( result.xAxisLineStyles.stroke ).toBe( defaultTheme.xAxisLineStyles.stroke );
+		expect( result.xTickLineStyles.stroke ).toBe( defaultTheme.xTickLineStyles.stroke );
+		expect( result.svgLabelSmall.fill ).toBe( defaultTheme.svgLabelSmall.fill );
+
+		expect( merged.backgroundColor ).toBe( '#111' );
+		expect( merged.gridStyles.stroke ).toBe( '#222' );
+	} );
+
+	it( 'leaves fields alone when no role was overridden', () => {
+		const merged = mergeThemes( defaultTheme, {
+			tickLength: 8,
+			leaderboardChart: { deltaColors: [ 'red', 'grey', 'green' ] },
+		} as Partial< ChartTheme > );
+
+		const result = withCatalogPointers( merged, [] );
+
+		expect( result.tickLength ).toBe( 8 );
+		expect( result.gridStyles.stroke ).toBe( defaultTheme.gridStyles.stroke );
+		// Not a mapped role, so its literal survives even when other roles are being restored.
+		expect( result.leaderboardChart.deltaColors ).toEqual( [ 'red', 'grey', 'green' ] );
+	} );
+} );