@carto/ps-react-ui 5.0.0-widgets.9 → 5.0.0

package/src/widgets-v2/actions/brush-toggle/brush-toggle.test.tsx

@@ -0,0 +1,180 @@
+import { describe, it, expect, beforeEach, afterEach, vi } from 'vitest'
+import { act, fireEvent, render, screen } from '@testing-library/react'
+import type { ECharts } from 'echarts'
+import { BrushToggle } from './brush-toggle'
+import { Provider } from '../../provider/widget-provider'
+import {
+  applyTransforms,
+  clearAllWidgetStores,
+  getWidgetStore,
+  setEchartInstance,
+} from '../../stores'
+
+interface ChartHandlers {
+  finished?: () => void
+}
+
+interface MockChart {
+  dispatchAction: ReturnType<typeof vi.fn>
+  on: (ev: string, cb: () => void) => void
+  off: (ev: string, cb: () => void) => void
+  __handlers: ChartHandlers
+}
+
+function makeMockChart(): MockChart {
+  const handlers: ChartHandlers = {}
+  return {
+    dispatchAction: vi.fn(),
+    on: (ev, cb) => {
+      if (ev === 'finished') handlers.finished = cb
+    },
+    off: (ev) => {
+      if (ev === 'finished') handlers.finished = undefined
+    },
+    __handlers: handlers,
+  }
+}
+
+beforeEach(() => clearAllWidgetStores())
+afterEach(() => clearAllWidgetStores())
+
+describe('<BrushToggle>', () => {
+  it('starts disabled by default', () => {
+    render(
+      <Provider id='bt-1' data={[]}>
+        <BrushToggle />
+      </Provider>,
+    )
+    expect(screen.getByLabelText('Enable brush selection')).toBeTruthy()
+  })
+
+  it('respects initialEnabled=true', () => {
+    render(
+      <Provider id='bt-2' data={[]}>
+        <BrushToggle initialEnabled />
+      </Provider>,
+    )
+    expect(screen.getByLabelText('Disable brush selection')).toBeTruthy()
+  })
+
+  it('clicking enables the transform — brush config appears in the post-pipeline option', () => {
+    render(
+      <Provider id='bt-3' data={[1]}>
+        <BrushToggle />
+      </Provider>,
+    )
+    fireEvent.click(screen.getByLabelText('Enable brush selection'))
+    // configTransforms now apply inside <Widget.Echart>; replay the
+    // pipeline locally over a blank structural option.
+    const configTransforms = getWidgetStore('bt-3').getState().configTransforms
+    const opts = applyTransforms({}, configTransforms) as {
+      brush?: { xAxisIndex?: string }
+    }
+    expect(opts.brush).toBeTruthy()
+    expect(opts.brush?.xAxisIndex).toBe('all')
+  })
+
+  it('dispatches takeGlobalCursor with brush config when enabled and a chart is registered', () => {
+    const chart = makeMockChart()
+    setEchartInstance('bt-4', chart as unknown as ECharts)
+    render(
+      <Provider id='bt-4' data={[1]}>
+        <BrushToggle initialEnabled />
+      </Provider>,
+    )
+    expect(chart.dispatchAction).toHaveBeenCalledWith({
+      type: 'takeGlobalCursor',
+      key: 'brush',
+      brushOption: { brushType: 'lineX', brushMode: 'multiple' },
+    })
+  })
+
+  it("re-dispatches takeGlobalCursor on the chart's 'finished' event", () => {
+    const chart = makeMockChart()
+    setEchartInstance('bt-5', chart as unknown as ECharts)
+    render(
+      <Provider id='bt-5' data={[1]}>
+        <BrushToggle initialEnabled />
+      </Provider>,
+    )
+    chart.dispatchAction.mockClear()
+    act(() => chart.__handlers.finished?.())
+    expect(chart.dispatchAction).toHaveBeenCalledWith({
+      type: 'takeGlobalCursor',
+      key: 'brush',
+      brushOption: { brushType: 'lineX', brushMode: 'multiple' },
+    })
+  })
+
+  it('on disable: clears the global cursor and wipes drawn areas', () => {
+    const chart = makeMockChart()
+    setEchartInstance('bt-6', chart as unknown as ECharts)
+    render(
+      <Provider id='bt-6' data={[1]}>
+        <BrushToggle initialEnabled />
+      </Provider>,
+    )
+    chart.dispatchAction.mockClear()
+    fireEvent.click(screen.getByLabelText('Disable brush selection'))
+    expect(chart.dispatchAction).toHaveBeenCalledWith({
+      type: 'takeGlobalCursor',
+    })
+    expect(chart.dispatchAction).toHaveBeenCalledWith({
+      type: 'brush',
+      areas: [],
+    })
+  })
+
+  it('honors brushType=rect and brushMode=single', () => {
+    const chart = makeMockChart()
+    setEchartInstance('bt-7', chart as unknown as ECharts)
+    render(
+      <Provider id='bt-7' data={[1]}>
+        <BrushToggle initialEnabled brushType='rect' brushMode='single' />
+      </Provider>,
+    )
+    expect(chart.dispatchAction).toHaveBeenCalledWith({
+      type: 'takeGlobalCursor',
+      key: 'brush',
+      brushOption: { brushType: 'rect', brushMode: 'single' },
+    })
+  })
+
+  it('wipes drawn brush areas when an external selection is cleared while enabled', () => {
+    const chart = makeMockChart()
+    setEchartInstance('bt-9', chart as unknown as ECharts)
+    const { rerender } = render(
+      <Provider id='bt-9' data={[1]}>
+        <BrushToggle initialEnabled selection={['a', 'b']} />
+      </Provider>,
+    )
+    chart.dispatchAction.mockClear()
+    rerender(
+      <Provider id='bt-9' data={[1]}>
+        <BrushToggle initialEnabled selection={[]} />
+      </Provider>,
+    )
+    expect(chart.dispatchAction).toHaveBeenCalledWith({
+      type: 'brush',
+      areas: [],
+    })
+  })
+
+  it('attaches the cursor reactively when the chart arrives *after* the toggle mounts', () => {
+    const chart = makeMockChart()
+    render(
+      <Provider id='bt-8' data={[1]}>
+        <BrushToggle initialEnabled />
+      </Provider>,
+    )
+    // Chart not yet registered — no dispatch should have happened.
+    expect(chart.dispatchAction).not.toHaveBeenCalled()
+    // Simulate the bridge mounting and publishing the instance.
+    act(() => setEchartInstance('bt-8', chart as unknown as ECharts))
+    expect(chart.dispatchAction).toHaveBeenCalledWith({
+      type: 'takeGlobalCursor',
+      key: 'brush',
+      brushOption: { brushType: 'lineX', brushMode: 'multiple' },
+    })
+  })
+})

package/src/widgets-v2/actions/brush-toggle/brush-toggle.tsx

@@ -0,0 +1,154 @@
+import { useEffect, type ComponentType } from 'react'
+import { IconButton, type SvgIconProps } from '@mui/material'
+import { HighlightAlt as HighlightAltIcon } from '@mui/icons-material'
+import { Tooltip } from '../../../components'
+import {
+  useEchartInstance,
+  useSingleTransform,
+  useWidgetId,
+} from '../../stores'
+import { addBrush } from './transforms'
+import { DEFAULT_BRUSH_TOGGLE_LABELS, type BrushToggleLabels } from './labels'
+import { styles } from './style'
+
+const BRUSH_DESCRIPTOR = {
+  id: 'brush-toggle',
+  type: 'config' as const,
+  order: 25,
+}
+
+export interface BrushToggleProps {
+  initialEnabled?: boolean
+  /**
+   * ECharts brush type. `'lineX'` (default) selects a range on the
+   * x-axis — appropriate for bar / histogram / timeseries. `'rect'`
+   * selects a 2-D rectangle — use for scatterplot. Other ECharts
+   * brush types (`'lineY'`, `'polygon'`) are also accepted.
+   */
+  brushType?: 'lineX' | 'lineY' | 'rect' | 'polygon'
+  /**
+   * `'multiple'` (default) lets the user draw additional brushes on
+   * top of existing ones. `'single'` replaces the previous brush on
+   * each new draw.
+   */
+  brushMode?: 'multiple' | 'single'
+  /**
+   * Optional view of the consumer-owned selection. When provided and
+   * the array is empty (`[]`), any brush rectangles currently drawn on
+   * the chart are wiped — keeps the UI in sync when the parent clears
+   * the selection externally (e.g. via `Widget.SelectionSummary`'s
+   * `onClear`). Pass the same array that drives `useChartSelection` /
+   * the option factory's `selection` input.
+   *
+   * Leave `undefined` to opt out — the sync effect becomes a no-op.
+   */
+  selection?: readonly unknown[] | null
+  labels?: Partial<BrushToggleLabels>
+  icon?: ComponentType<SvgIconProps>
+  iconProps?: SvgIconProps
+}
+
+/**
+ * Toggle ECharts' brush selection mode. Two-part wiring:
+ *
+ *   1. The config transform (`addBrush`) installs the `brush`
+ *      component on the option so brushed items get the
+ *      `outOfBrush` dim treatment.
+ *   2. ECharts only enters "brush cursor" mode when something
+ *      dispatches `takeGlobalCursor({ key: 'brush', ... })`. This
+ *      component drives that dispatch via {@link useEchartInstance},
+ *      reacting when the chart instance becomes available (the
+ *      `BrushToggle` mounts before `Widget.Echart` in tree order, so
+ *      on first mount the chart isn't ready yet).
+ *
+ *   3. ECharts clears the global cursor on every `setOption`, so we
+ *      re-dispatch on each `'finished'` event — required for
+ *      `brushMode: 'multiple'` to keep working across selection-driven
+ *      re-renders, RelativeData toggles, etc.
+ *
+ * Selection events (`brushSelected` / `brushEnd`) flow through the
+ * existing `useChartSelection` wiring at the consumer level — no extra
+ * plumbing here.
+ */
+export function BrushToggle({
+  initialEnabled = false,
+  brushType = 'lineX',
+  brushMode = 'multiple',
+  selection,
+  labels,
+  icon: Icon = HighlightAltIcon,
+  iconProps,
+}: BrushToggleProps) {
+  const id = useWidgetId()
+  const _labels = { ...DEFAULT_BRUSH_TOGGLE_LABELS, ...labels }
+  const { enabled, toggle } = useSingleTransform(
+    id,
+    BRUSH_DESCRIPTOR,
+    addBrush,
+    { initialEnabled },
+  )
+
+  // Reactive read of the live instance — the effect below re-runs when
+  // the chart arrives, departs, or re-inits, instead of polling.
+  const chart = useEchartInstance(id)
+
+  useEffect(() => {
+    if (!chart) return undefined
+    if (!enabled) {
+      // Disabled: exit brush cursor and wipe any drawn rectangles.
+      chart.dispatchAction({ type: 'takeGlobalCursor' })
+      chart.dispatchAction({ type: 'brush', areas: [] })
+      return undefined
+    }
+
+    const enterBrush = (): void => {
+      chart.dispatchAction({
+        type: 'takeGlobalCursor',
+        key: 'brush',
+        brushOption: { brushType, brushMode },
+      })
+    }
+
+    // Every `setOption` clears the global cursor. Re-dispatch after
+    // each chart render so `brushMode: 'multiple'` stays usable across
+    // selection-driven re-renders, RelativeData toggles, etc.
+    const onFinished = (): void => enterBrush()
+    chart.on('finished', onFinished)
+    enterBrush()
+
+    return () => {
+      chart.off('finished', onFinished)
+    }
+  }, [chart, enabled, brushType, brushMode])
+
+  // Sync the drawn rectangles with the external selection. When the
+  // parent flips `selection` to `[]` (e.g. SelectionSummary's "Clear"
+  // button), wipe the brush areas so the chart UI matches the data.
+  // Dispatching with an empty `areas` array when nothing is drawn is a
+  // safe no-op on ECharts, so no extra "previous value" bookkeeping is
+  // needed. Kept as a separate effect so a parent selection change
+  // doesn't tear down / re-attach the `'finished'` listener above.
+  useEffect(() => {
+    if (!chart || !enabled) return
+    if (selection?.length === 0) {
+      chart.dispatchAction({ type: 'brush', areas: [] })
+    }
+  }, [chart, enabled, selection])
+
+  const tooltip = enabled ? _labels.on : _labels.off
+
+  return (
+    <Tooltip title={tooltip}>
+      <IconButton
+        size='small'
+        aria-label={tooltip}
+        aria-pressed={enabled}
+        onClick={toggle}
+        className={enabled ? 'active' : undefined}
+        sx={{ ...styles.toggle, ...(enabled && styles.toggleActive) }}
+      >
+        <Icon fontSize='small' {...iconProps} />
+      </IconButton>
+    </Tooltip>
+  )
+}

package/src/widgets-v2/actions/brush-toggle/index.ts

@@ -0,0 +1,3 @@
+export { BrushToggle, type BrushToggleProps } from './brush-toggle'
+export { addBrush } from './transforms'
+export { DEFAULT_BRUSH_TOGGLE_LABELS, type BrushToggleLabels } from './labels'

package/src/widgets-v2/actions/brush-toggle/labels.ts

@@ -0,0 +1,9 @@
+export interface BrushToggleLabels {
+  on: string
+  off: string
+}
+
+export const DEFAULT_BRUSH_TOGGLE_LABELS: BrushToggleLabels = {
+  on: 'Disable brush selection',
+  off: 'Enable brush selection',
+}

package/src/widgets-v2/actions/brush-toggle/style.ts

@@ -0,0 +1,11 @@
+import type { SxProps, Theme } from '@mui/material'
+
+export const styles = {
+  toggle: {
+    p: 0.5,
+    '& .MuiSvgIcon-root': { fontSize: 20 },
+  },
+  toggleActive: {
+    background: (theme: Theme) => theme.palette.primary.relatedLight,
+  },
+} satisfies Record<string, SxProps<Theme>>

package/src/widgets-v2/actions/brush-toggle/transforms.test.ts

@@ -0,0 +1,47 @@
+import { describe, it, expect } from 'vitest'
+import { addBrush } from './transforms'
+
+describe('addBrush', () => {
+  it('adds a brush block with rect/clear toolbox', () => {
+    const out = addBrush({}) as {
+      brush: { toolbox: string[]; xAxisIndex: string }
+    }
+    expect(out.brush.toolbox).toEqual(['rect', 'clear'])
+    expect(out.brush.xAxisIndex).toBe('all')
+  })
+
+  it('configures outOfBrush dim alpha at 0.15 (matches v1)', () => {
+    const out = addBrush({}) as {
+      brush: { outOfBrush: { colorAlpha: number } }
+    }
+    expect(out.brush.outOfBrush.colorAlpha).toBe(0.15)
+  })
+
+  it('adds the toolbox.feature.brush so the user gets the brush UI', () => {
+    const out = addBrush({}) as {
+      toolbox: { feature: { brush: { type: string[] } } }
+    }
+    expect(out.toolbox.feature.brush.type).toEqual(['rect', 'clear'])
+  })
+
+  it('preserves an existing toolbox config and adds the brush feature on top', () => {
+    const seeded = {
+      toolbox: { right: 8, feature: { saveAsImage: {} } },
+    }
+    const out = addBrush(seeded) as {
+      toolbox: {
+        right: number
+        feature: { saveAsImage: object; brush: object }
+      }
+    }
+    expect(out.toolbox.right).toBe(8)
+    expect(out.toolbox.feature.saveAsImage).toEqual({})
+    expect(out.toolbox.feature.brush).toBeDefined()
+  })
+
+  it('returns the input unchanged when not an object', () => {
+    expect(addBrush(null)).toBe(null)
+    expect(addBrush(undefined)).toBe(undefined)
+    expect(addBrush(42)).toBe(42)
+  })
+})

package/src/widgets-v2/actions/brush-toggle/transforms.ts

@@ -0,0 +1,31 @@
+/**
+ * Brush config transform: enables ECharts' brush component on the option
+ * object. Module-level constant — identity stable across renders.
+ *
+ * Pairs with `replaceMergeKeys: ['brush']` so the pipeline replaces (not
+ * merges) the brush config on every config-pipeline run. v1 needed a
+ * mousemove re-dispatch hack to keep the brush state across data updates;
+ * v2 keeps brush state continuous via `notMerge: false` + dynamic
+ * replaceMerge in the EchartUI layer (D6) — no hack required.
+ */
+export const addBrush = (option: unknown): unknown => {
+  if (option == null || typeof option !== 'object') return option
+  const cfg = option as Record<string, unknown>
+  return {
+    ...cfg,
+    brush: {
+      toolbox: ['rect', 'clear'],
+      xAxisIndex: 'all',
+      brushLink: 'all',
+      outOfBrush: { colorAlpha: 0.15 },
+    },
+    toolbox: {
+      ...((cfg.toolbox as object | undefined) ?? {}),
+      show: false,
+      feature: {
+        ...((cfg.toolbox as { feature?: object } | undefined)?.feature ?? {}),
+        brush: { type: ['rect', 'clear'] },
+      },
+    },
+  }
+}

package/src/widgets-v2/actions/change-column/change-column-icon.tsx

@@ -0,0 +1,14 @@
+import { SvgIcon, type SvgIconProps } from '@mui/material'
+
+export function ChangeColumnIcon(props: SvgIconProps) {
+  return (
+    <SvgIcon viewBox='0 0 18 18' {...props}>
+      <path
+        fill='currentColor'
+        fillRule='evenodd'
+        d='M14.25 2.25H3.75c-.825 0-1.5.675-1.5 1.5v10.5c0 .825.675 1.5 1.5 1.5h10.5c.825 0 1.5-.675 1.5-1.5V3.75c0-.825-.675-1.5-1.5-1.5m-3.75 12h-3V3.75h3zM3.75 3.75H6v10.5H3.75zM12 14.25V3.75h2.25v10.5z'
+        clipRule='evenodd'
+      />
+    </SvgIcon>
+  )
+}

package/src/widgets-v2/actions/change-column/change-column.test.tsx

@@ -0,0 +1,59 @@
+import { describe, it, expect, beforeEach, afterEach } from 'vitest'
+import { fireEvent, render, screen } from '@testing-library/react'
+import { Provider } from '../../provider/widget-provider'
+import { clearAllWidgetStores, getWidgetStore } from '../../stores'
+import { ChangeColumn } from './change-column'
+import type { ChangeColumnWidgetState } from './types'
+
+beforeEach(() => clearAllWidgetStores())
+afterEach(() => clearAllWidgetStores())
+
+const ITEMS = [
+  { id: 'a', label: 'Alpha' },
+  { id: 'b', label: 'Beta' },
+  { id: 'c', label: 'Gamma' },
+]
+
+describe('<ChangeColumn>', () => {
+  it('renders nothing when fewer than two columns are provided', () => {
+    const { container } = render(
+      <Provider id='cc1' data={[]}>
+        <ChangeColumn columns={[ITEMS[0]!]} />
+      </Provider>,
+    )
+    expect(container.querySelector('button')).toBeNull()
+  })
+
+  it('renders the trigger and opens the menu listing every column in order', () => {
+    render(
+      <Provider id='cc2' data={[]}>
+        <ChangeColumn columns={ITEMS} labels={{ trigger: 'Reorder' }} />
+      </Provider>,
+    )
+    fireEvent.click(screen.getByLabelText('Reorder'))
+    const items = screen.getAllByRole('menuitem')
+    expect(items.map((el) => el.textContent)).toEqual([
+      'Alpha',
+      'Beta',
+      'Gamma',
+    ])
+  })
+
+  it('uses columnOrder from the store when present', () => {
+    render(
+      <Provider id='cc3' data={[]}>
+        <ChangeColumn columns={ITEMS} labels={{ trigger: 'Reorder' }} />
+      </Provider>,
+    )
+    getWidgetStore('cc3').setState({
+      columnOrder: ['c', 'a', 'b'],
+    } as Partial<ChangeColumnWidgetState>)
+    fireEvent.click(screen.getByLabelText('Reorder'))
+    const items = screen.getAllByRole('menuitem')
+    expect(items.map((el) => el.textContent)).toEqual([
+      'Gamma',
+      'Alpha',
+      'Beta',
+    ])
+  })
+})