Rename PlotType to TraceType, add alias

Author: camdecoster

src/types/ARCHITECTURE.md

@@ -45,7 +45,8 @@ The split:
   types**.
   - **`src/types/generated/schema.d.ts`** contains:
     - **Common enum aliases** discovered from the schema (Calendar, Dash,
-      AxisType, PatternShape, XRef, YRef, TransitionEasing, PlotType).
+      AxisType, PatternShape, XRef, YRef, TransitionEasing, TraceType — plus
+      a deprecated `PlotType` alias for back-compat).
     - **Shared sub-interfaces** extracted from repeated subtrees (Font,
       FontArray, ColorBar, HoverLabel, Domain, Pattern, TickFormatStops,
       LegendGroupTitle).
@@ -138,7 +139,8 @@ test/plot-schema.json (runtime schema: traces + layout + animation + config)
     │
     │ 0. Discover common enum aliases via COMMON_TYPE_ANCHORS
     │    (Calendar/Dash/AxisType/PatternShape/XRef/YRef/TransitionEasing,
-    │    plus PlotType derived from the trace-names list)
+    │    plus TraceType derived from the trace-names list, plus a deprecated
+    │    `PlotType` alias)
     │ 1. Fingerprint every container subtree across traces and layout
     │ 2. Extract shared interfaces (Font, ColorBar, HoverLabel, etc.).
     │    Inject Transition and AnimationFrameOpts as shared types
@@ -156,7 +158,9 @@ test/plot-schema.json (runtime schema: traces + layout + animation + config)
 src/types/generated/schema.d.ts
     │ // Common enum aliases
     │ export type Calendar = 'chinese' | 'coptic' | ...;
-    │ export type PlotType = 'bar' | 'scatter' | ...;
+    │ export type TraceType = 'bar' | 'scatter' | ...;
+    │ /** @deprecated Renamed to TraceType. */
+    │ export type PlotType = TraceType;
     │ // Shared interfaces (public)
     │ export interface Font { ... }
     │ export interface ColorBar { ... }

src/types/GENERATOR.md

@@ -5,7 +5,7 @@ reads `plot-schema.json` and emits all the schema-derived TypeScript
 types into `src/types/generated/schema.d.ts`:
 
 - Common enum aliases (Calendar, Dash, AxisType, PatternShape, XRef, YRef,
-  TransitionEasing, PlotType)
+  TransitionEasing, TraceType — plus a deprecated `PlotType` alias)
 - Shared sub-interfaces (Font, ColorBar, HoverLabel, etc.)
 - Data interfaces for each trace type (BarData, ScatterData, IndicatorData, etc.)
 - Layout component interfaces (LayoutAxis, Legend, Scene, Annotation, etc.)
@@ -43,8 +43,9 @@ const COMMON_TYPE_ANCHORS = [
 When multiple sites match an anchor (e.g. 3D scene axes vs cartesian axes
 both have `xaxis.type` enumerations), the generator picks the largest
 value set — the superset — so the alias is always permissive enough.
-`PlotType` is special-cased: derived from `Object.keys(schema.traces)`
-rather than from an attribute.
+`TraceType` is special-cased: derived from `Object.keys(schema.traces)`
+rather than from an attribute. A deprecated `PlotType = TraceType` alias
+is also emitted for back-compat with prior versions of the type surface.
 
 Each discovered alias is emitted as `export type Name = 'a' | 'b' | ...`
 and registered in `VALUES_TO_COMMON_TYPE` so subsequent emission of any
@@ -184,7 +185,7 @@ descriptions are escaped to prevent prematurely closing the comment.
 src/types/generated/schema.d.ts
 ├── import { Color, ColorScale, Datum, MarkerSymbol, TypedArray } from '../lib/common'
 ├── Common enum types (Calendar, Dash, AxisType, PatternShape, XRef, YRef,
-│                      TransitionEasing, PlotType)
+│                      TransitionEasing, TraceType + deprecated PlotType alias)
 ├── Shared interfaces — public (Font, FontArray, ColorBar, HoverLabel, Domain,
 │                                Pattern, TickFormatStops, LegendGroupTitle, ...)
 ├── Internal shared interfaces in `namespace _internal` (Marker, Line,
@@ -242,9 +243,10 @@ you want a named alias for it:
    and rewrites matching enumerated attributes to reference the alias.
 3. Run `npm run typecheck` to verify.
 
-`PlotType` is a special case derived from `Object.keys(schema.traces)`
+`TraceType` is a special case derived from `Object.keys(schema.traces)`
 rather than from an enumerated attribute; it doesn't follow the anchor
-mechanism.
+mechanism. A deprecated `PlotType = TraceType` alias is emitted alongside it
+to keep older imports working.
 
 ### Adding a new layout container
 

src/types/README.md

@@ -46,7 +46,7 @@ The following are **auto-generated from `plot-schema.json`** by
 `tasks/generate_schema_types.mjs`:
 
 - Common enum aliases (Calendar, Dash, AxisType, PatternShape, XRef, YRef,
-  TransitionEasing, PlotType)
+  TransitionEasing, TraceType — and a deprecated `PlotType` alias)
 - Data interfaces for each trace type (BarData, ScatterData, IndicatorData, etc.)
 - Layout component interfaces (LayoutAxis, Legend, Scene, Annotation,
   Shape, Slider, UpdateMenu, etc.) and the Layout interface itself

src/types/core/data.d.ts

@@ -58,13 +58,14 @@ import type {
     SunburstData,
     SurfaceData,
     TableData,
+    TraceType,
     TreemapData,
     ViolinData,
     VolumeData,
     WaterfallData
 } from '../generated/schema';
 
-export type { PlotType };
+export type { PlotType, TraceType };
 
 /**
  * Union of every trace shape. All fields are optional via `Partial<…>` —

src/types/core/layout.d.ts

@@ -9,7 +9,7 @@
  */
 
 import type { Layout } from '../generated/schema';
-import type { Data, PlotType } from './data';
+import type { Data, TraceType } from './data';
 import type { PlotlyHTMLElement } from './events';
 
 // ---------------------------------------------------------------------------
@@ -142,7 +142,7 @@ export type ModeBarButtonAny = ModeBarDefaultButtons | ModeBarButton;
  */
 export interface Template {
     /** Template trace defaults, keyed by trace type. */
-    data?: { [type in PlotType]?: Data[] } | undefined;
+    data?: { [type in TraceType]?: Data[] } | undefined;
     /** Template layout defaults. */
     layout?: Partial<Layout> | undefined;
 }

src/types/generated/schema.d.ts

@@ -23,7 +23,10 @@ export type PatternShape = '' | '/' | '\\' | 'x' | '-' | '|' | '+' | '.';
 
 export type TransitionEasing = 'linear' | 'quad' | 'cubic' | 'sin' | 'exp' | 'circle' | 'elastic' | 'back' | 'bounce' | 'linear-in' | 'quad-in' | 'cubic-in' | 'sin-in' | 'exp-in' | 'circle-in' | 'elastic-in' | 'back-in' | 'bounce-in' | 'linear-out' | 'quad-out' | 'cubic-out' | 'sin-out' | 'exp-out' | 'circle-out' | 'elastic-out' | 'back-out' | 'bounce-out' | 'linear-in-out' | 'quad-in-out' | 'cubic-in-out' | 'sin-in-out' | 'exp-in-out' | 'circle-in-out' | 'elastic-in-out' | 'back-in-out' | 'bounce-in-out';
 
-export type PlotType = 'bar' | 'barpolar' | 'box' | 'candlestick' | 'carpet' | 'choropleth' | 'choroplethmap' | 'choroplethmapbox' | 'cone' | 'contour' | 'contourcarpet' | 'densitymap' | 'densitymapbox' | 'funnel' | 'funnelarea' | 'heatmap' | 'histogram' | 'histogram2d' | 'histogram2dcontour' | 'icicle' | 'image' | 'indicator' | 'isosurface' | 'mesh3d' | 'ohlc' | 'parcats' | 'parcoords' | 'pie' | 'sankey' | 'scatter' | 'scatter3d' | 'scattercarpet' | 'scattergeo' | 'scattergl' | 'scattermap' | 'scattermapbox' | 'scatterpolar' | 'scatterpolargl' | 'scattersmith' | 'scatterternary' | 'splom' | 'streamtube' | 'sunburst' | 'surface' | 'table' | 'treemap' | 'violin' | 'volume' | 'waterfall';
+export type TraceType = 'bar' | 'barpolar' | 'box' | 'candlestick' | 'carpet' | 'choropleth' | 'choroplethmap' | 'choroplethmapbox' | 'cone' | 'contour' | 'contourcarpet' | 'densitymap' | 'densitymapbox' | 'funnel' | 'funnelarea' | 'heatmap' | 'histogram' | 'histogram2d' | 'histogram2dcontour' | 'icicle' | 'image' | 'indicator' | 'isosurface' | 'mesh3d' | 'ohlc' | 'parcats' | 'parcoords' | 'pie' | 'sankey' | 'scatter' | 'scatter3d' | 'scattercarpet' | 'scattergeo' | 'scattergl' | 'scattermap' | 'scattermapbox' | 'scatterpolar' | 'scatterpolargl' | 'scattersmith' | 'scatterternary' | 'splom' | 'streamtube' | 'sunburst' | 'surface' | 'table' | 'treemap' | 'violin' | 'volume' | 'waterfall';
+
+/** @deprecated Renamed to TraceType. */
+export type PlotType = TraceType;
 
 // ---------------------------------------------------------------------------
 // Shared interfaces — extracted from repeated attribute subtrees

tasks/generate_schema_types.mjs

@@ -81,7 +81,8 @@ function refName(name, inInternalNamespace) {
 /**
  * Walk the schema to find the canonical `values` array for each anchor in
  * `COMMON_TYPE_ANCHORS`. The first matching enumerated attribute wins.
- * Also emits a `PlotType` alias derived from the trace-names list.
+ * Also emits a `TraceType` alias derived from the trace-names list,
+ * plus a deprecated `PlotType` alias for back-compat.
  *
  * Populates `VALUES_TO_COMMON_TYPE` and returns `Map<name, {values}>` for
  * emitting type aliases.
@@ -131,8 +132,9 @@ function discoverCommonTypes(schema) {
         VALUES_TO_COMMON_TYPE.set(JSON.stringify(best.slice().sort()), anchor.name);
     }
 
-    // PlotType — derived from the list of trace names, not from an attribute.
-    found.set('PlotType', { values: Object.keys(schema.traces).sort() });
+    // TraceType — derived from the list of trace names, not from an attribute.
+    // (A deprecated `PlotType` alias is also emitted; see the emit loop.)
+    found.set('TraceType', { values: Object.keys(schema.traces).sort() });
 
     return found;
 }
@@ -1107,6 +1109,12 @@ export function generateSchemaTypes(schema, outputPath) {
         chunks.push('');
     }
 
+    // Deprecated back-compat alias — kept so existing consumers importing
+    // `PlotType` continue to work. New code should use `TraceType`.
+    chunks.push('/** @deprecated Renamed to TraceType. */');
+    chunks.push('export type PlotType = TraceType;');
+    chunks.push('');
+
     // Emit shared interfaces — public ones at the top level, "internal" ones
     // wrapped in `export namespace _internal { ... }` so consumers reach them
     // via the namespace prefix rather than directly.
@@ -1268,6 +1276,7 @@ export function generateSchemaTypes(schema, outputPath) {
     // falsely flag them as missing.
     const exportedNames = new Set();
     for (const name of commonTypes.keys()) exportedNames.add(name);
+    exportedNames.add('PlotType');
     for (const [name] of sharedList) {
         if (!INTERNAL_INTERFACES.has(name)) exportedNames.add(name);
     }