Address PR feedback

Author: camdecoster

src/types/core/api.d.ts

@@ -221,6 +221,13 @@ export function relayout(root: Root, layout: LayoutUpdate): Promise<PlotlyHTMLEl
  * @param val - New value of the attribute
  */
 export function relayout(root: Root, astr: string, val: any): Promise<PlotlyHTMLElement>;
+/**
+ * Update layout properties on an existing plot with either call form.
+ *
+ * This signature lets a wrapper read the parameter types with `Parameters<typeof relayout>`.
+ * It does not check that the value matches the form.
+ */
+export function relayout(root: Root, astr: string | LayoutUpdate, val?: any): Promise<PlotlyHTMLElement>;
 /** Re-render the plot at `root` from its current data/layout. */
 export function redraw(root: Root): Promise<PlotlyHTMLElement>;
 /** Remove a plot and its event listeners from the DOM. */
@@ -240,6 +247,18 @@ export function restyle(root: Root, aobj: DataUpdate, traces?: number[] | number
  * @param traces - Trace index/indices to update (defaults to all)
  */
 export function restyle(root: Root, astr: string, val: any, traces?: number[] | number): Promise<PlotlyHTMLElement>;
+/**
+ * Update trace properties (style) on the existing plot with either call form.
+ *
+ * This signature lets a wrapper read the parameter types with `Parameters<typeof restyle>`.
+ * It does not check that the arguments match the form.
+ */
+export function restyle(
+    root: Root,
+    astr: string | DataUpdate,
+    val?: any,
+    traces?: number[] | number
+): Promise<PlotlyHTMLElement>;
 
 /**
  * Update both trace and layout properties in a single call.

src/types/core/events.d.ts

@@ -150,24 +150,12 @@ export interface PlotRestyleEventUpdate {
 export type PlotRestyleEvent = [PlotRestyleEventUpdate, number[]];
 
 /**
- * Payload for `plotly_relayout`. Carries a `LayoutUpdate`, so any attribute
- * path is a valid key, plus typed values for a few common axis-range and
- * autorange keys that flatten nested updates.
+ * Payload for `plotly_relayout`. The keys are layout properties or attribute
+ * paths of the changed values, for example `'xaxis.range[0]'`. A value behind an
+ * attribute path has the type `any`, because a range value can be a number or a
+ * date string.
  */
-export interface PlotRelayoutEvent extends LayoutUpdate {
-    /** New x-axis range minimum, when the user changed the range. */
-    'xaxis.range[0]'?: number;
-    /** New x-axis range maximum, when the user changed the range. */
-    'xaxis.range[1]'?: number;
-    /** New y-axis range minimum, when the user changed the range. */
-    'yaxis.range[0]'?: number;
-    /** New y-axis range maximum, when the user changed the range. */
-    'yaxis.range[1]'?: number;
-    /** True when the user toggled x-axis autoranging on. */
-    'xaxis.autorange'?: boolean;
-    /** True when the user toggled y-axis autoranging on. */
-    'yaxis.autorange'?: boolean;
-}
+export type PlotRelayoutEvent = LayoutUpdate;
 
 // ---------------------------------------------------------------------------
 // 3D scene / annotation / animation / legend events

test/types/relayout_event.ts

@@ -8,12 +8,9 @@ import type { PlotRelayoutEvent } from '../../lib/index';
 
 declare const event: PlotRelayoutEvent;
 
-// Typed keys keep their value types
-const rangeStart: number | undefined = event['xaxis.range[0]'];
-const autorange: boolean | undefined = event['xaxis.autorange'];
-
-// @ts-expect-error the typed range key holds a number, not a string
-const rangeStartAsString: string | undefined = event['xaxis.range[0]'];
+// A range value can be a number or a date string
+const numberRangeStart: number | undefined = event['xaxis.range[0]'];
+const dateRangeStart: string | undefined = event['xaxis.range[0]'];
 
 // Any other attribute path is readable
 const secondAxisStart = event['xaxis2.range[0]'];

test/types/update_api.ts

@@ -1,7 +1,7 @@
 /**
  * Consumer-side checks for the `relayout`, `restyle` and `update` types.
  *
- * Nothing here runs. `npm run typecheck` compiles this file against the public entry point.
+ * Nothing here runs. `npm run test-types` compiles this file against the public entry point.
  * A line marked `@ts-expect-error` must fail to compile, so the build breaks if a type becomes too permissive.
  */
 
@@ -27,8 +27,11 @@ Plotly.relayout(gd, 'annotations[0].text', 'hello');
 Plotly.relayout(gd, { titl: 'abc' });
 // @ts-expect-error wrong value type on a known top-level key
 Plotly.relayout(gd, { autosize: 'yes' });
-// @ts-expect-error the string form needs a value
-Plotly.relayout(gd, 'xaxis.autorange');
+
+// A wrapper that reads the parameter types must see both call forms
+type RelayoutArg = Parameters<typeof Plotly.relayout>[1];
+export const relayoutObject: RelayoutArg = { autosize: true };
+export const relayoutPath: RelayoutArg = 'xaxis.autorange';
 
 // ---------------------------------------------------------------------------
 // restyle
@@ -45,8 +48,10 @@ Plotly.restyle(gd, 'marker.color', ['red', 'blue'], [0, 1]);
 Plotly.restyle(gd, { colr: 'red' });
 // @ts-expect-error wrong value type on a known top-level key
 Plotly.restyle(gd, { visible: 'maybe' });
-// @ts-expect-error the string form needs a value
-Plotly.restyle(gd, 'marker.color');
+
+type RestyleArg = Parameters<typeof Plotly.restyle>[1];
+export const restyleObject: RestyleArg = { visible: false };
+export const restylePath: RestyleArg = 'marker.color';
 
 // ---------------------------------------------------------------------------
 // update