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

package/dist/types/widgets-v2/echart/use-chart-selection.d.ts

@@ -0,0 +1,57 @@
+import { CallbackDataParams } from 'echarts/types/dist/shared';
+import { EchartsEventHandler } from './echart-ui.js';
+export type SelectionKey = string | number;
+export interface UseChartSelectionOptions<K extends SelectionKey> {
+    /**
+     * Controlled selection. `undefined`/`null`/an explicit `[]` all mean "no
+     * selection interaction" — every current merger already treats an empty
+     * selection as "nothing excluded," so this hook collapses all three to
+     * `null` rather than promising per-merger `[]` semantics it doesn't
+     * implement.
+     */
+    selection?: readonly K[];
+    /** Receives the next selection. When omitted the wiring is a no-op. */
+    onSelectionChange?: (next: readonly K[]) => void;
+    /**
+     * Pull a selection key out of an ECharts `click` event. Return `null` to
+     * skip (e.g. a click on empty plot area). For Bar/Pie/Timeseries this is
+     * usually `(p) => p.name`; for Histogram/Scatterplot it's the dataIndex.
+     */
+    keyFromClick: (params: CallbackDataParams) => K | null;
+    /**
+     * Map a `brushSelected` payload's `selected[*]` entries (each carrying a
+     * `seriesIndex` + `dataIndex[]`) into the full set of selection keys for
+     * the brushed area. Called once per brush event.
+     */
+    keysFromBrush: (selected: readonly {
+        seriesIndex: number;
+        dataIndex: number[];
+    }[]) => K[];
+}
+export interface ChartSelectionWiring<K extends SelectionKey> {
+    /**
+     * Pass straight to `<Widget.Echart onEvents={…}>`. Wires `click` and
+     * `brushSelected` so the user's interactions reach `onSelectionChange`.
+     */
+    onEvents: Record<string, EchartsEventHandler>;
+    /**
+     * The current selection — `null` for "no selection interaction"
+     * (`undefined`/`null`/an explicit `[]`), or a non-empty array meaning
+     * "render only these as fully opaque, dim the rest".
+     */
+    selection: readonly K[] | null;
+}
+/**
+ * Translate ECharts' click + brush events into a consumer-owned selection
+ * with the expected dashboard semantics:
+ *
+ *   - **Click toggles** — clicking an item adds it to the selection if
+ *     absent, removes it if present.
+ *   - **Brush replaces** — finishing a brush stroke overwrites the selection
+ *     with whatever the brush covered (drag-to-empty clears).
+ *
+ * Wire the returned `onEvents` into `<Widget.Echart>` and feed
+ * `wiring.selection` to the widget's option factory so the merger can dim
+ * non-selected rows at fusion time.
+ */
+export declare function useChartSelection<K extends SelectionKey>({ selection, onSelectionChange, keyFromClick, keysFromBrush, }: UseChartSelectionOptions<K>): ChartSelectionWiring<K>;

package/dist/types/widgets-v2/formula/delta.d.ts

@@ -0,0 +1,22 @@
+import { ChipProps } from '@mui/material';
+import { DeltaSeverity } from './types.js';
+export interface DeltaProps {
+    /** Numeric magnitude. Used for the default percent label and severity inference. */
+    value: number;
+    /** Pre-formatted label override; skips the default percent formatter. */
+    label?: string;
+    /**
+     * Visual treatment. When omitted it's derived from the sign of `value`:
+     * `>0 → 'positive'`, `<0 → 'negative'`, `=0 → 'neutral'`.
+     */
+    severity?: DeltaSeverity;
+    /** Override the default `Intl.NumberFormat({style:'percent'})` formatter. */
+    format?: (value: number) => string;
+    ChipProps?: ChipProps;
+}
+/**
+ * Comparative delta rendered as a small filled chip. Colour is driven by
+ * `severity` (or the sign of `value`); content is `label`, the result of
+ * `format(value)`, or the default percent format.
+ */
+export declare function Delta({ value, label, severity, format, ChipProps: chipProps, }: DeltaProps): import('react').JSX.Element;

package/dist/types/widgets-v2/formula/download.d.ts

@@ -0,0 +1,20 @@
+import { DownloadItem } from '../actions/download/index.js';
+import { FormulaWidgetData } from './types.js';
+export interface FormulaDownloadConfigArgs {
+    filename: string;
+    getData: () => FormulaWidgetData;
+    /**
+     * Optional getter for the widget's capture element (registered by
+     * `Widget.State`). When provided, a PNG item is prepended.
+     */
+    getCaptureEl?: () => HTMLElement | null;
+    pngPixelRatio?: number;
+    pngBackgroundColor?: string | null;
+}
+/**
+ * Builds download items for the Formula widget. Always includes a CSV item
+ * with one row per KPI (`prefix`, `value`, `suffix`, `note`, `delta`).
+ * When `getCaptureEl` is supplied, prepends a PNG item that rasterises the
+ * captured element via `html2canvas`.
+ */
+export declare function createFormulaDownloadConfig(args: FormulaDownloadConfigArgs): DownloadItem[];

package/dist/types/widgets-v2/formula/formula-ui.d.ts

@@ -0,0 +1,20 @@
+import { Ref } from 'react';
+import { FormulaDataItem } from './types.js';
+export interface FormulaUIProps {
+    items: readonly FormulaDataItem[];
+    /** Number formatter — applied to each item's `value`. */
+    formatter?: (value: number) => string;
+    /** Forwarded to the root `<Box>` so consumers can capture the DOM (PNG export). */
+    ref?: Ref<HTMLDivElement>;
+}
+/**
+ * Pure presentational component for the Formula widget. Each item renders as
+ * a row containing (in order): optional `Series` avatar, a body with
+ * `[prefix] value [suffix]` plus optional `Note`, and an optional `Delta`
+ * chip pushed to the right edge.
+ *
+ * For fully custom layouts, compose {@link Series}, {@link Prefix},
+ * {@link Value}, {@link Suffix}, {@link Note}, and {@link Delta} directly
+ * instead of passing `items`.
+ */
+export declare function FormulaUI({ items, formatter, ref }: FormulaUIProps): import('react').JSX.Element;

package/dist/types/widgets-v2/formula/formula.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Stateful Formula bridge — reads `data` (post-pipeline) and `formatter` from
+ * the per-widget store and forwards them to the pure {@link FormulaUI}. Sits
+ * inside `<Widget.Provider>`. Demonstrates that the composition shell
+ * (Provider, Wrapper, State) doesn't care whether the rendered child is
+ * ECharts (Bar) or a custom DOM tree (Formula).
+ */
+export declare function Formula(): import('react').JSX.Element;

package/dist/types/widgets-v2/formula/index.d.ts

@@ -0,0 +1,11 @@
+export { Formula } from './formula.js';
+export { FormulaUI, type FormulaUIProps } from './formula-ui.js';
+export { Prefix, type PrefixProps } from './prefix.js';
+export { Suffix, type SuffixProps } from './suffix.js';
+export { Value, type ValueProps } from './value.js';
+export { Series, type SeriesProps } from './series.js';
+export { Note, type NoteProps } from './note.js';
+export { Delta, type DeltaProps } from './delta.js';
+export { FormulaSkeleton, type FormulaSkeletonProps } from './skeleton.js';
+export { createFormulaDownloadConfig } from './download.js';
+export type { FormulaDataItem, FormulaWidgetData, FormulaSeries, FormulaDelta, DeltaSeverity, } from './types.js';

package/dist/types/widgets-v2/formula/note.d.ts

@@ -0,0 +1,11 @@
+import { TypographyProps } from '@mui/material';
+import { ReactNode } from 'react';
+export interface NoteProps {
+    children: ReactNode;
+    TypographyProps?: TypographyProps;
+}
+/**
+ * Small subdued caption rendered below a Formula value. Use for short
+ * descriptive text (e.g. "Last 7 days", "Excludes refunds").
+ */
+export declare function Note({ children, TypographyProps }: NoteProps): import('react').JSX.Element;

package/dist/types/widgets-v2/formula/prefix.d.ts

@@ -0,0 +1,12 @@
+import { TypographyProps } from '@mui/material';
+import { ReactNode } from 'react';
+export interface PrefixProps {
+    children: ReactNode;
+    TypographyProps?: TypographyProps;
+}
+/**
+ * Prefix slot for a Formula KPI — large, bold, muted (`text.secondary`).
+ * Composable building block for custom formula layouts; the canonical
+ * {@link FormulaUI} renders one of these per item when `prefix` is set.
+ */
+export declare function Prefix({ children, TypographyProps }: PrefixProps): import('react').JSX.Element;

package/dist/types/widgets-v2/formula/series.d.ts

@@ -0,0 +1,16 @@
+import { AvatarProps } from '@mui/material';
+export interface SeriesProps {
+    /** Used for the avatar's first-letter glyph and as accessible label. */
+    name: string;
+    /** Avatar background colour (any MUI palette path or CSS colour). */
+    color?: string;
+    /** Diameter in px. Default `24`. */
+    size?: number;
+    AvatarProps?: AvatarProps;
+}
+/**
+ * Series indicator — circular avatar showing the first letter of `name`.
+ * Background colour is `color` (consumer-supplied) or a neutral disabled
+ * colour, with text colour computed for contrast against it.
+ */
+export declare function Series({ name, color, size, AvatarProps: avatarProps, }: SeriesProps): import('react').JSX.Element;

package/dist/types/widgets-v2/formula/skeleton.d.ts

@@ -0,0 +1,4 @@
+export interface FormulaSkeletonProps {
+    count?: number;
+}
+export declare function FormulaSkeleton({ count }: FormulaSkeletonProps): import('react').JSX.Element;

package/dist/types/widgets-v2/formula/style.d.ts

@@ -0,0 +1,29 @@
+export declare const styles: {
+    root: {
+        display: "flex";
+        flexDirection: "column";
+        gap: number;
+        alignItems: "stretch";
+    };
+    row: {
+        display: "flex";
+        alignItems: "flex-start";
+        gap: number;
+    };
+    body: {
+        flex: number;
+        minWidth: number;
+        display: "flex";
+        flexDirection: "column";
+        gap: number;
+    };
+    valueRow: {
+        display: "inline-flex";
+        alignItems: "baseline";
+        gap: number;
+    };
+    delta: {
+        alignSelf: "center";
+        flexShrink: number;
+    };
+};

package/dist/types/widgets-v2/formula/suffix.d.ts

@@ -0,0 +1,12 @@
+import { TypographyProps } from '@mui/material';
+import { ReactNode } from 'react';
+export interface SuffixProps {
+    children: ReactNode;
+    TypographyProps?: TypographyProps;
+}
+/**
+ * Suffix slot for a Formula KPI — large, bold, muted (`text.secondary`).
+ * Composable building block for custom formula layouts; the canonical
+ * {@link FormulaUI} renders one of these per item when `suffix` is set.
+ */
+export declare function Suffix({ children, TypographyProps }: SuffixProps): import('react').JSX.Element;

package/dist/types/widgets-v2/formula/types.d.ts

@@ -0,0 +1,43 @@
+import { WidgetSeries } from '../types.js';
+/**
+ * Series metadata rendered as a coloured avatar at the start of a row.
+ *
+ * Type alias of the cross-widget {@link WidgetSeries} shape so the same
+ * `{ name, color? }` object can drive Formula avatars, Spread avatars,
+ * Category legends, and echart-widget legends with no per-widget shape
+ * gymnastics. Kept as a named export for backwards compatibility.
+ */
+export type FormulaSeries = WidgetSeries;
+export type DeltaSeverity = 'positive' | 'negative' | 'neutral';
+/** Comparative delta rendered as a coloured chip on the right of a row. */
+export interface FormulaDelta {
+    /** Numeric magnitude. Default formatting renders as a percent (e.g. `-12,3 %`). */
+    value: number;
+    /** Pre-formatted label override (skips the default percent formatter). */
+    label?: string;
+    /**
+     * Visual treatment override. When omitted it's derived from `value`'s sign:
+     * `>0 → 'positive'`, `<0 → 'negative'`, `=0 → 'neutral'`.
+     */
+    severity?: DeltaSeverity;
+}
+/** A single KPI value rendered by the Formula widget. */
+export interface FormulaDataItem {
+    value: number;
+    prefix?: string;
+    suffix?: string;
+    /** Override the value's text colour (e.g. `'success.main'`). */
+    color?: string;
+    /** Optional series indicator — coloured avatar with first letter of `name`. */
+    series?: FormulaSeries;
+    /** Optional caption rendered below the value. */
+    note?: string;
+    /** Optional comparative delta chip rendered to the right of the row. */
+    delta?: FormulaDelta;
+}
+/**
+ * Formula widget data — an array of KPI items rendered top-to-bottom. A common
+ * "single big number" widget is just `[{ value: 123 }]`. Multi-series usage
+ * sets `series`, `note`, and/or `delta` per item.
+ */
+export type FormulaWidgetData = readonly FormulaDataItem[];

package/dist/types/widgets-v2/formula/value.d.ts

@@ -0,0 +1,14 @@
+import { TypographyProps } from '@mui/material';
+import { ReactNode } from 'react';
+export interface ValueProps {
+    children: ReactNode;
+    /** Override the default `text.primary` color — useful for sparkline tints. */
+    color?: string;
+    TypographyProps?: TypographyProps;
+}
+/**
+ * Value slot for a Formula KPI — large, bold, primary text color. Composable
+ * building block for custom formula layouts; the canonical {@link FormulaUI}
+ * renders one of these per item.
+ */
+export declare function Value({ children, color, TypographyProps }: ValueProps): import('react').JSX.Element;

package/dist/types/widgets-v2/histogram/download.d.ts

@@ -0,0 +1,17 @@
+import { DownloadItem } from '../actions/download/index.js';
+import { HistogramWidgetData } from './types.js';
+/**
+ * Download menu items for histograms. Always includes a CSV item with
+ * `bin_low, bin_high, series_1_count, series_2_count, …` columns (one row
+ * per bin). When `getCaptureEl` is supplied, prepends a PNG item that
+ * rasterises the captured element via `html2canvas`.
+ */
+export declare function createHistogramDownloadConfig(args: {
+    filename: string;
+    getData: () => HistogramWidgetData;
+    getTicks: () => readonly number[];
+    seriesNames?: readonly string[];
+    getCaptureEl?: () => HTMLElement | null;
+    pngPixelRatio?: number;
+    pngBackgroundColor?: string | null;
+}): DownloadItem[];

package/dist/types/widgets-v2/histogram/index.d.ts

@@ -0,0 +1,5 @@
+export { histogramOptions, createHistogramOptionFactory } from './options.js';
+export { HistogramSkeleton, type HistogramSkeletonProps } from './skeleton.js';
+export { createHistogramDownloadConfig } from './download.js';
+export { toRelativeHistogramData, filterHistogramByLockedBins, } from './transforms.js';
+export type { HistogramWidgetData, HistogramOptionsInput, HistogramOptionFactoryInput, HistogramEChartsOption, } from './types.js';

package/dist/types/widgets-v2/histogram/options.d.ts

@@ -0,0 +1,42 @@
+import { OptionFactory } from '../echart/index.js';
+import { HistogramEChartsOption, HistogramOptionFactoryInput, HistogramOptionsInput } from './types.js';
+/**
+ * Builds the **structural** ECharts option for a histogram widget — axes,
+ * grid, tooltip, value-axis label formatter, themed legend. Mirrors
+ * {@link import('../bar/options.js').barOptions} so the two widgets share v1
+ * look-and-feel: themed dark tooltip with positioner, CARTO color palette,
+ * structural legend (`show` toggled by the merger based on series count),
+ * y-axis labels rendered inside the plot via the `niceNum` closure pattern.
+ *
+ * Intentional deviations from bar (histogram-specific):
+ *   - **No `xAxis.axisLabel.formatter`.** Bin labels are pre-formatted in
+ *     the merger via `formatNumber(lo)–formatNumber(hi)` and optionally
+ *     the consumer's `labelFormatter`. The strings on the axis are
+ *     already display-ready, so there's nothing to post-format here.
+ *   - **Tooltip formatter reads the array-tuple row shape.** The dataset
+ *     uses positional `encode: { x: 0, y: 1 }`, so `item.value` comes in
+ *     as `[binLabel, count]` rather than bar's `{ name, value }` object.
+ *
+ * Intentionally data-agnostic: no series, no dataset, no x-axis category
+ * data (those depend on data + ticks and are added by the option factory's
+ * merge phase via {@link createHistogramOptionFactory}).
+ */
+export declare function histogramOptions({ theme, formatter, }: HistogramOptionsInput): HistogramEChartsOption;
+/**
+ * Returns the histogram widget's {@link OptionFactory} — one closure that
+ * owns BOTH phases of option construction:
+ *
+ *   - **Structural phase** (`option == null`) — builds the theme-aware
+ *     structural option via {@link histogramOptions}, optionally merging
+ *     the consumer-supplied `optionsOverride`. Called once by Provider to
+ *     seed `rawOptions` in the store.
+ *   - **Merge phase** (`option != null`) — fuses post-pipeline `state.data`
+ *     (`HistogramWidgetData` — `number[][]`) into the option via the
+ *     dataset API. Each series gets its own dataset of `[binLabel, count]`
+ *     pairs derived from `ticks`; series reference their dataset by
+ *     `datasetIndex` and are encoded by column position. Reactive
+ *     `ctx.formatter` (driven by RelativeData → `%`) plus `niceMin`/`niceMax`
+ *     are re-derived here so the y-axis label formatter and the tooltip
+ *     pick up live store values, mirroring bar.
+ */
+export declare function createHistogramOptionFactory(options: HistogramOptionFactoryInput): OptionFactory;

package/dist/types/widgets-v2/histogram/skeleton.d.ts

@@ -0,0 +1,9 @@
+export interface HistogramSkeletonProps {
+    bins?: number;
+}
+/**
+ * Loading state for the Histogram widget. Mirrors Bar's skeleton structure
+ * — a grid of bars (bin-shaped silhouette, anchored to the bottom) plus a
+ * legend stub — so the placeholder reads consistently with Bar.
+ */
+export declare function HistogramSkeleton({ bins }: HistogramSkeletonProps): import('react').JSX.Element;

package/dist/types/widgets-v2/histogram/transforms.d.ts

@@ -0,0 +1,28 @@
+/**
+ * Histogram-specific `RelativeData` transform. Histogram data is
+ * `number[][]` — each series is a flat list of bin counts. This
+ * rewrites each count to its share of the series total (0–100), so
+ * pairing with `createPercentFormatter` renders the y-axis as
+ * percentages.
+ *
+ * Pass to `<Widget.RelativeData transform={toRelativeHistogramData} />`.
+ *
+ * The denominator is the sum of |value| across the series so mixed-sign
+ * inputs produce sane signed shares-of-magnitude. A series whose total
+ * magnitude is zero (all-zero or empty input) is returned unchanged so
+ * a stalled or empty data set doesn't show misleading 0% values. Inputs
+ * whose shape isn't `number[][]` fall through untouched (same defensive
+ * shape-check pattern as the default transform).
+ */
+export declare const toRelativeHistogramData: (input: unknown) => unknown;
+/**
+ * `LockSelection` filter for Histogram. Data is `number[][]` — a flat list
+ * of bin counts per series, positionally paired with `ticks` (bin `i` covers
+ * `[ticks[i], ticks[i+1])`). Unlike name-keyed widgets, locked-out bins can't
+ * be REMOVED — that would shift every later bin's index and desync it from
+ * its `ticks` range. Zeroing them out instead preserves array length/position,
+ * so locked bins just render as empty (height 0) rather than disappearing.
+ *
+ * `lockedItems` holds bin indices (numbers, from Histogram's `selection`).
+ */
+export declare function filterHistogramByLockedBins(input: unknown, lockedItems: readonly (string | number)[]): unknown;

package/dist/types/widgets-v2/histogram/types.d.ts

@@ -0,0 +1,60 @@
+import { Theme } from '@mui/material';
+import { EChartsOption } from 'echarts';
+import { WidgetSeries } from '../types.js';
+/**
+ * Histogram widget data — array of series, each a flat array of bin counts.
+ * The option factory's merge phase (see {@link createHistogramOptionFactory})
+ * combines this with `ticks` to produce a 2-column dataset (`[binLabel, count]`)
+ * for ECharts.
+ */
+export type HistogramWidgetData = readonly (readonly number[])[];
+/** Inputs to the structural-only {@link histogramOptions} builder. */
+export interface HistogramOptionsInput {
+    theme: Theme;
+    formatter?: (value: number) => string;
+}
+/**
+ * Combined inputs for the histogram option factory creator. Carries
+ * everything the widget needs across BOTH phases — the structural-build
+ * (`theme`, `formatter`, `optionsOverride`) AND the data merge (`ticks`,
+ * `series`, `labelFormatter`, `selection`).
+ */
+export interface HistogramOptionFactoryInput {
+    theme: Theme;
+    formatter?: (value: number) => string;
+    /** Bin boundaries — length = bins + 1. */
+    ticks: readonly number[];
+    /**
+     * Per-series metadata — drives the legend, `series[i].name`, and
+     * (when `color` is set) a per-series colour override on the bars.
+     */
+    series?: readonly WidgetSeries[];
+    /**
+     * Bin-range label transform (e.g. `"0–10"` → `"[0–10)"`). Distinct from
+     * the standard `OptionFactoryContext.labelFormatter` (which operates on
+     * categories): this one is histogram-specific and runs only on the
+     * generated bin-range strings before they hit the x-axis.
+     */
+    labelFormatter?: (label: string) => string;
+    /**
+     * Selected bin indices. Bins not in this list render dimmed
+     * (`itemStyle.opacity: 0.15`). `null`/empty means no selection.
+     */
+    selection?: readonly number[] | null;
+    /**
+     * Locked bin indices (from `LockSelection`). The x-axis crops its visible
+     * window to `[min(lockedItems), max(lockedItems)]` so the chart actually
+     * zooms into the locked range instead of showing every bin label with
+     * zeroed-out bars outside it. `null`/empty means no crop. Histogram's
+     * selection is always a contiguous run (`use-widget-filters`'s BETWEEN
+     * envelope round-trip fills any gaps), so min/max fully describes it.
+     */
+    lockedItems?: readonly number[] | null;
+    /**
+     * Consumer-supplied partial option merged into the structural option at
+     * structural-build time. Lets stories override pieces of the theme-aware
+     * base without forking the structural builder.
+     */
+    optionsOverride?: Partial<EChartsOption>;
+}
+export type HistogramEChartsOption = EChartsOption;

package/dist/types/widgets-v2/index.d.ts

@@ -0,0 +1,109 @@
+import { Provider } from './provider/widget-provider.js';
+import { Wrapper, Actions, Options, Content, Footer, DEFAULT_WRAPPER_LABELS } from './wrapper/index.js';
+import { Subheader } from './subheader/subheader.js';
+import { State } from './state/widget-state.js';
+import { DEFAULT_STATE_LABELS } from './state/labels.js';
+import { SelectionSummary } from './selection-summary/selection-summary.js';
+import { DEFAULT_SELECTION_SUMMARY_LABELS } from './selection-summary/labels.js';
+import { Toolbox } from './toolbox/toolbox.js';
+import { DEFAULT_TOOLBOX_LABELS } from './toolbox/labels.js';
+import { Echart, EchartUI, DEFAULT_INIT_OPTS } from './echart/index.js';
+import { DEFAULT_NOTE_LABELS } from './note/labels.js';
+import { Searcher, SearcherToggle, StackToggle, ShowAllToggle, ZoomToggle, BrushToggle, RelativeData, Download, LockSelection, ChangeColumn } from './actions/index.js';
+import { Formula, FormulaUI } from './formula/index.js';
+import { Markdown, MarkdownUI } from './markdown/index.js';
+import { Spread, SpreadUI } from './spread/index.js';
+import { Range, RangeUI } from './range/index.js';
+import { Category, CategoryUI } from './category/index.js';
+import { Table, TableUI } from './table/index.js';
+/**
+ * Curated namespace export — the only way to reach v2 widget components.
+ * Consumers import the const and access components via property access:
+ *
+ * ```tsx
+ * import { Widget } from '@carto/ps-react-ui/widgets-v2'
+ *
+ * <Widget.Provider id={id} data={data}>
+ *   <Widget.Wrapper title='Sales'>
+ *     <Widget.Content>
+ *       <Widget.State skeleton={<BarSkeleton />}>
+ *         <Widget.Echart optionFactory={optionFactory} />
+ *       </Widget.State>
+ *     </Widget.Content>
+ *   </Widget.Wrapper>
+ * </Widget.Provider>
+ * ```
+ *
+ * Component identifiers are not surfaced as separate named exports — Types
+ * (props, data shapes, label types, default-label consts) and per-widget
+ * subpath entries (`@carto/ps-react-ui/widgets-v2/bar`, `…/category`,
+ * `…/table`, `…/actions`, `…/stores`, `…/utils`, etc.) remain available for
+ * direct import where needed.
+ */
+export declare const Widget: {
+    readonly Provider: typeof Provider;
+    readonly Wrapper: typeof Wrapper;
+    readonly Actions: typeof Actions;
+    readonly Options: typeof Options;
+    readonly Content: typeof Content;
+    readonly Footer: typeof Footer;
+    readonly Subheader: typeof Subheader;
+    readonly State: typeof State;
+    readonly SelectionSummary: typeof SelectionSummary;
+    readonly Toolbox: typeof Toolbox;
+    readonly Note: (({ lineClamp, labels, children }: import('./index.js').NoteProps) => import('react').JSX.Element) & {
+        Markdown: ({ content, lineClamp, labels }: import('./index.js').NoteMarkdownProps) => import('react').JSX.Element;
+    };
+    readonly Echart: typeof Echart;
+    readonly EchartUI: typeof EchartUI;
+    readonly Searcher: typeof Searcher;
+    readonly SearcherToggle: typeof SearcherToggle;
+    readonly StackToggle: typeof StackToggle;
+    readonly ShowAllToggle: typeof ShowAllToggle;
+    readonly ZoomToggle: typeof ZoomToggle;
+    readonly BrushToggle: typeof BrushToggle;
+    readonly RelativeData: typeof RelativeData;
+    readonly Download: typeof Download;
+    readonly FullScreen: {
+        Trigger: ({ labels, enterIcon: EnterIcon, exitIcon: ExitIcon, iconProps, }: import('./actions/index.js').FullScreenTriggerProps) => import('react').JSX.Element;
+        Slot: ({ children, title, labels, closeIcon: CloseSvg, iconProps, }: import('./actions/index.js').FullScreenSlotProps) => import('react').JSX.Element;
+    };
+    readonly LockSelection: typeof LockSelection;
+    readonly ChangeColumn: typeof ChangeColumn;
+    readonly Formula: typeof Formula;
+    readonly FormulaUI: typeof FormulaUI;
+    readonly Markdown: typeof Markdown;
+    readonly MarkdownUI: typeof MarkdownUI;
+    readonly Spread: typeof Spread;
+    readonly SpreadUI: typeof SpreadUI;
+    readonly Range: typeof Range;
+    readonly RangeUI: typeof RangeUI;
+    readonly Category: typeof Category;
+    readonly CategoryUI: typeof CategoryUI;
+    readonly Table: typeof Table;
+    readonly TableUI: typeof TableUI;
+};
+export { DEFAULT_WRAPPER_LABELS, DEFAULT_STATE_LABELS, DEFAULT_SELECTION_SUMMARY_LABELS, DEFAULT_TOOLBOX_LABELS, DEFAULT_NOTE_LABELS, DEFAULT_INIT_OPTS, };
+export type { ProviderProps } from './provider/widget-provider.js';
+export type { WrapperProps, ActionsProps, OptionsProps, ContentProps, FooterProps, WrapperLabels, } from './wrapper/index.js';
+export type { SubheaderProps } from './subheader/subheader.js';
+export type { StateProps } from './state/widget-state.js';
+export type { StateLabels } from './state/labels.js';
+export type { SelectionSummaryProps } from './selection-summary/selection-summary.js';
+export type { SelectionSummaryLabels } from './selection-summary/labels.js';
+export type { ToolboxProps } from './toolbox/toolbox.js';
+export type { ToolboxLabels } from './toolbox/labels.js';
+export type { EchartProps, EchartUIProps, EchartsEventHandler } from './echart/index.js';
+export type { NoteProps, NoteMarkdownProps } from './note/widget-note.js';
+export type { NoteLabels } from './note/labels.js';
+export type { SearcherProps, SearcherToggleProps, StackToggleProps, ShowAllToggleProps, ZoomToggleProps, BrushToggleProps, RelativeDataProps, DownloadProps, DownloadItem, FullScreenTriggerProps, FullScreenSlotProps, LockSelectionProps, LockSelectionKey, ChangeColumnProps, ChangeColumnItem, } from './actions/index.js';
+export type { FormulaUIProps, FormulaDataItem, FormulaWidgetData, } from './formula/index.js';
+export type { MarkdownUIProps, MarkdownWidgetData } from './markdown/index.js';
+export type { PieDatum, PieWidgetData } from './pie/index.js';
+export type { TimeseriesDatum, TimeseriesWidgetData } from './timeseries/index.js';
+export type { ScatterplotDatum, ScatterplotWidgetData } from './scatterplot/index.js';
+export type { SpreadUIProps, SpreadDataItem, SpreadWidgetData, SpreadVariant, } from './spread/index.js';
+export type { RangeProps, RangeUIProps, RangeDataItem, RangeWidgetData, RangeItemValue, } from './range/index.js';
+export type { CategoryProps, CategoryUIProps, CategoryDataItem, CategoryWidgetData, CategoryKey, CategorySeriesConfig, CategoryLabels, } from './category/index.js';
+export type { TableProps, TableUIProps, TableColumn, TableRow, TableWidgetData, TableWidgetState, TableSortDirection, TableSortState, } from './table/index.js';
+export type { WidgetSeries } from './types.js';

package/dist/types/widgets-v2/markdown/download.d.ts

@@ -0,0 +1,16 @@
+import { toCsvString, triggerLinkDownload, DownloadItem } from '../actions/download/index.js';
+import { MarkdownWidgetData } from './types.js';
+/**
+ * Download menu items for the Markdown widget. Always includes a `.md`
+ * item that saves the markdown source verbatim. When `getCaptureEl` is
+ * supplied, prepends a PNG item that rasterises the captured element via
+ * `html2canvas`.
+ */
+export declare function createMarkdownDownloadConfig(args: {
+    filename: string;
+    getData: () => MarkdownWidgetData;
+    getCaptureEl?: () => HTMLElement | null;
+    pngPixelRatio?: number;
+    pngBackgroundColor?: string | null;
+}): DownloadItem[];
+export { toCsvString, triggerLinkDownload };

package/dist/types/widgets-v2/markdown/index.d.ts

@@ -0,0 +1,6 @@
+export { Markdown } from './markdown.js';
+export { MarkdownUI, type MarkdownUIProps } from './markdown-ui.js';
+export { MarkdownContent, type MarkdownContentProps } from './markdown-content.js';
+export { MarkdownSkeleton, type MarkdownSkeletonProps } from './skeleton.js';
+export { createMarkdownDownloadConfig } from './download.js';
+export type { MarkdownWidgetData } from './types.js';

package/dist/types/widgets-v2/markdown/markdown-content.d.ts

@@ -0,0 +1,40 @@
+import { Components } from 'react-markdown';
+export interface MarkdownContentProps {
+    /** Markdown source. */
+    content: string;
+    /**
+     * Element overrides. Consumers (`MarkdownUI`, `Note`, …) supply their own
+     * typography / link styling here; the engine itself stays opinion-free.
+     */
+    components?: Components;
+    /**
+     * When `true`, raw HTML in the source is rendered. Defaults to `false` so
+     * caption slots like `Note` stay safe-by-default; the document-style
+     * Markdown widget opts in.
+     */
+    allowHtml?: boolean;
+    /**
+     * When `true`, `<img>` / `![alt](url)` markdown produces an `<img>` tag.
+     * Defaults to `false` so caption slots stay text-only by default.
+     */
+    allowImages?: boolean;
+    /**
+     * When `true`, enables GitHub Flavored Markdown (tables, strikethrough,
+     * task lists, autolinks) via `remark-gfm`. Defaults to `false` so existing
+     * consumers keep CommonMark-only parsing.
+     */
+    gfm?: boolean;
+}
+/**
+ * Low-level Markdown rendering primitive. Wraps `react-markdown` with two
+ * opt-in capabilities (`allowHtml`, `allowImages`) and a consumer-supplied
+ * component map for typography. Both default OFF — Note-style consumers
+ * are safe-by-default; MarkdownUI opts both ON to render rich content.
+ *
+ * `allowHtml` plugs in `rehype-raw` so raw HTML nodes in the source are
+ * actually parsed, then `rehype-sanitize` with the default schema strips
+ * `<script>`, event handlers, and dangerous URL schemes from the parsed
+ * tree. `safeUrlTransform` is always applied as a second layer for markdown
+ * links/images on the `allowHtml=false` path.
+ */
+export declare function MarkdownContent({ content, components, allowHtml, allowImages, gfm, }: MarkdownContentProps): import('react').JSX.Element;