@svgrid/grid 2.6.19 → 2.6.21

package/dist/SvGrid.controller.svelte.d.ts

@@ -160,6 +160,7 @@ export declare function createSvGridController<TFeatures extends TableFeatures =
     readonly showColumnFiltersEffective: boolean;
     readonly showInlineColumnFilterEffective: boolean;
     readonly showRowSelectionEffective: boolean;
+    readonly rowSummariesEnabled: boolean;
     readonly enableCellSelectionEffective: boolean;
     readonly flushScheduledScrollSync: () => void;
     readonly scheduleScrollSync: (scrollTop: number, scrollLeft: number) => void;

package/dist/SvGrid.controller.svelte.js

@@ -1,6 +1,7 @@
 import { applyGroupAggregate, applyRowPredicate, compileExcelFilter, getAdvancedFilterEngine, normalizeForFilter, createColumnVirtualizer, createCoreRowModel, createExpandedRowModel, createFilteredRowModel, createGroupedRowModel, createTreeRowModel, createSvelteVirtualizer, createSortedRowModel, createSvGrid, getGridCellDomId, sortFns, } from "./index.js";
 import { createRowScrollScaling, resolveMaxDomHeight, } from "./virtualization/scroll-scaling.js";
 import { buildPreMeasureItems } from "./virtualization/virtualizer.js";
+import { DEV } from "esm-env";
 import "./sv-grid-scrollbar.js";
 import { computeColumnStat, formatsNeedingStats, formatNeedsStats, } from "./conditional-formatting.js";
 import { rawToNumber, } from "./SvGrid.helpers.js";
@@ -407,6 +408,14 @@ export function createSvGridController(rawProps, domIdBase) {
         props.enableCellSelection ??
         ((props.selectionMode ?? "both") === "cell" ||
             (props.selectionMode ?? "both") === "both"));
+    // The aggregate footer row. `summary` is the shortcut alias, so it wins over
+    // the fine-grained prop - the same precedence `selectable` uses.
+    //
+    // It starts OFF. It used to default ON, which meant a plain
+    // `<SvGrid {data} {columns} />` grew a totals row nobody asked for, and every
+    // caller that did not want one had to say so: 375 call sites in this repo
+    // passed `enableRowSummaries={false}` against 6 that opted in.
+    const rowSummariesEnabled = $derived(props.summary ?? props.enableRowSummaries ?? false);
     // Internal source-of-truth for data and column defs. Seeded from props and
     // re-synced whenever the parent passes a new array; the imperative API
     // mutates these so add/remove operations don't need a callback round-trip.
@@ -2216,7 +2225,7 @@ export function createSvGridController(rawProps, domIdBase) {
     const eagerSummaries = $derived.by(() => {
         if (!summarize)
             return null;
-        if (!(props.enableRowSummaries ?? true))
+        if (!rowSummariesEnabled)
             return null;
         const rows = allRows;
         const columns = allColumns;
@@ -2241,7 +2250,7 @@ export function createSvGridController(rawProps, domIdBase) {
         void editedCellValues;
         const rows = allRows;
         const columns = allColumns;
-        if (!(props.enableRowSummaries ?? true)) {
+        if (!rowSummariesEnabled) {
             deferredSummaries = {};
             return;
         }
@@ -3012,6 +3021,7 @@ export function createSvGridController(rawProps, domIdBase) {
         get showColumnFiltersEffective() { return showColumnFiltersEffective; },
         get showInlineColumnFilterEffective() { return showInlineColumnFilterEffective; },
         get showRowSelectionEffective() { return showRowSelectionEffective; },
+        get rowSummariesEnabled() { return rowSummariesEnabled; },
         get enableCellSelectionEffective() { return enableCellSelectionEffective; },
         get flushScheduledScrollSync() { return flushScheduledScrollSync; },
         get scheduleScrollSync() { return scheduleScrollSync; },
@@ -3460,6 +3470,58 @@ export function createSvGridController(rawProps, domIdBase) {
     const { register: registerAlignedGrid, broadcastScroll: broadcastAlignedScroll, broadcastWidths: broadcastAlignedWidths } = createAlignedGrids(ctx);
     const { buildApi } = createGridApi(ctx);
     const { readCellRaw, writeCellRaw, applyFillPattern, clearSelectedCellValues, startFillDrag, onFillPointerMove, onFillPointerUp, toggleBooleanCell, copySelectionToClipboard, clearSelectedCells, cutSelectionToClipboard } = createClipboard(ctx);
+    // Dev-time configuration checks. Silent misconfiguration was the grid's
+    // biggest usability gap - a misspelled `field` rendered a column of blank
+    // cells and printed nothing, and an inert `pageSize` was simply ignored.
+    //
+    // `validateGridConfig` is pure (see validate.ts) so it can be unit-tested;
+    // this only decides when to run it, and prints each distinct message once.
+    //
+    // It is loaded with `import()` rather than a static import so the checks live
+    // in a lazy chunk. The base bundle is size-budgeted and already sits at its
+    // limit, so a static import cost ~1 KB gzip that a production app would carry
+    // and never execute.
+    //
+    // `DEV` comes from `esm-env` because the alternatives do not work here:
+    // `process.env.NODE_ENV` is undefined in Vite's browser runtime (the checks
+    // silently never ran), and Vite's own flag makes svelte-package warn that it
+    // only works for Vite consumers. esm-env resolves through export conditions,
+    // so it is correct in dev and folds to `false` in a production build. It is
+    // already a direct dependency of Svelte, so it adds nothing to an install.
+    if (DEV) {
+        const warnedConfig = new Set();
+        $effect(() => {
+            // Read the reactive values synchronously so the effect tracks them; the
+            // module load below is async and would otherwise register no dependencies.
+            const snapshot = {
+                data: internalData,
+                columns: internalColumns,
+                features: resolveEffectiveFeatures(),
+                sortable: props.sortable,
+                pageable: props.pageable,
+                showPagination: props.showPagination,
+                pageSize: props.pageSize,
+                groupBy: props.groupBy,
+                treeData: props.treeData,
+                initialColumnPinning: props.initialColumnPinning,
+                columnVirtualization: props.columnVirtualization,
+                externalPagination: props.externalPagination,
+                rowCount: props.rowCount,
+                externalSort: props.externalSort,
+                onSortingChange: props.onSortingChange,
+                externalFilter: props.externalFilter,
+                onFiltersChange: props.onFiltersChange,
+            };
+            void import("./validate.js").then(({ validateGridConfig }) => {
+                for (const message of validateGridConfig(snapshot)) {
+                    if (warnedConfig.has(message))
+                        continue;
+                    warnedConfig.add(message);
+                    console.warn(message);
+                }
+            });
+        });
+    }
     // Aligned grids: register in the shared group on mount, and mirror column
     // resizes to peers whenever columnWidths changes. Horizontal-scroll mirroring
     // is driven from onBodyScroll (via ctx.broadcastAlignedScroll).

package/dist/SvGrid.svelte

@@ -184,6 +184,7 @@
     ctrl.showInlineColumnFilterEffective,
   );
   const showRowSelectionEffective = $derived(ctrl.showRowSelectionEffective);
+  const rowSummariesEnabled = $derived(ctrl.rowSummariesEnabled);
   const grid = $derived(ctrl.grid);
   const allColumns = $derived(ctrl.allColumns);
   const headerGroups = $derived(ctrl.headerGroups);
@@ -2519,7 +2520,7 @@
               {/each}
             </tbody>
           {/if}
-          {#if opt.enableRowSummaries ?? true}
+          {#if rowSummariesEnabled}
             <!-- svelte-ignore a11y_no_redundant_roles -->
             <tfoot class="sv-grid-foot" role="rowgroup">
               <tr

package/dist/SvGrid.types.d.ts

@@ -993,7 +993,21 @@ export type Props<TFeatures extends TableFeatures = TableFeatures, TData extends
      * work; the shortcut wins only when it is explicitly set.
      */
     sortable?: boolean;
+    /**
+     * Click a header to filter that column. Injects `columnFilteringFeature`,
+     * so you do not import it yourself. Which filter surface appears is a
+     * separate question - see `filterMode` (default `'menu'`).
+     *
+     *   <SvGrid {data} {columns} filterable />
+     */
     filterable?: boolean;
+    /**
+     * Inline cell editing. Alias of `enableInlineEditing`, and wins over it when
+     * both are set. A column also needs an `editorType` to be editable; without
+     * one it falls back to a text editor.
+     *
+     *   <SvGrid {data} {columns} editable />
+     */
     editable?: boolean;
     /**
      * Cell selection - click a cell to select it, drag or shift-click to extend
@@ -1045,6 +1059,16 @@ export type Props<TFeatures extends TableFeatures = TableFeatures, TData extends
         /** Indent per depth level, in px. Default `12`. */
         indentPx?: number;
     };
+    /**
+     * Show the grouping controls: "Group by this column" in the column menu, and
+     * the group panel when `showGroupPanel` is on. Alias of
+     * `showGroupingControls`, and also injects `columnGroupingFeature`.
+     *
+     * This turns on the UI for grouping. To group without asking the user, set
+     * `groupBy` instead.
+     *
+     *   <SvGrid {data} {columns} groupable />
+     */
     groupable?: boolean;
     /**
      * Group the rows by these column ids, outermost first - `['region',
@@ -1122,7 +1146,19 @@ export type Props<TFeatures extends TableFeatures = TableFeatures, TData extends
     autoGroupColumnHeader?: string;
     /** Width (px) of each auto-group column. Default `220`. */
     autoGroupColumnWidth?: number;
+    /**
+     * Show the pagination footer. Alias of `showPagination`, and wins over it
+     * when both are set. Page size starts at `pageSize` (default 10).
+     *
+     *   <SvGrid {data} {columns} pageable pageSize={25} />
+     */
     pageable?: boolean;
+    /**
+     * Show the loading state instead of the rows. By default this replaces the
+     * grid body with "Loading..."; set `loadingOverlay` to keep the current rows
+     * visible under a dimmed overlay instead, which is what you usually want for
+     * a server-paged grid.
+     */
     loading?: boolean;
     /**
      * Render `loading` as a non-blocking overlay instead of replacing the
@@ -1134,7 +1170,16 @@ export type Props<TFeatures extends TableFeatures = TableFeatures, TData extends
     loadingOverlay?: boolean;
     /** Skeleton placeholder rows to show on first load. Defaults to 8. */
     loadingSkeletonRows?: number;
+    /**
+     * Render an error message in place of the rows. `null` or omitted means no
+     * error. Takes precedence over `loading` and over the empty state.
+     */
     error?: string | null;
+    /**
+     * Text shown when there are no rows to display - either the data is empty or
+     * a filter matched nothing. Defaults to the localized `noRows` string, so
+     * prefer `localization.text.noRows` when you are translating the whole grid.
+     */
     emptyMessage?: string;
     /**
      * The single place to localize the grid. One object with two fields:
@@ -1154,7 +1199,21 @@ export type Props<TFeatures extends TableFeatures = TableFeatures, TData extends
      * Omitting it (or any field) is a no-op. See {@link GridMessages}.
      */
     localization?: GridLocalization;
+    /**
+     * Show the single search box that filters across every column. Explicitly
+     * setting this wins over `filterMode`; leaving it unset means it appears only
+     * when `filterMode` is `'global'`.
+     */
     showGlobalFilter?: boolean;
+    /**
+     * Show the filter section inside each column's menu. Explicitly setting this
+     * wins over `filterMode`; unset, it follows `filterMode` (default `'menu'`,
+     * so this is normally on).
+     *
+     * Setting it `true` also adds the inline "floating filter" input under each
+     * header - that surface requires the explicit opt-in, since it otherwise
+     * duplicates the menu's own filter popover.
+     */
     showColumnFilters?: boolean;
     /**
      * Quick way to pick a single filtering UI. When set it controls which of
@@ -1163,8 +1222,23 @@ export type Props<TFeatures extends TableFeatures = TableFeatures, TData extends
      * Defaults to `'menu'` (only the column menu's filter section is shown).
      */
     filterMode?: "row" | "menu" | "global" | "none";
+    /**
+     * Show the grouping affordances (the column menu's "Group by this column",
+     * and the group panel). The `groupable` shortcut sets this and registers the
+     * grouping feature in one go; prefer that unless you have already registered
+     * `columnGroupingFeature` yourself.
+     */
     showGroupingControls?: boolean;
+    /**
+     * Show the row-selection checkbox column, including the select-all checkbox
+     * in the header. Unset, it follows `selectionMode` (default `'both'`, so
+     * row selection is on).
+     */
     showRowSelection?: boolean;
+    /**
+     * Show the pagination footer. Off by default. `pageable` is the shortcut
+     * alias and wins when both are set.
+     */
     showPagination?: boolean;
     /** Initial page size when pagination is enabled. Defaults to 10. */
     pageSize?: number;
@@ -1197,6 +1271,14 @@ export type Props<TFeatures extends TableFeatures = TableFeatures, TData extends
         pageIndex: number;
         pageSize: number;
     }) => void;
+    /**
+     * Render only the rows in view instead of all of them. **On by default** -
+     * this is what keeps a 100,000-row grid responsive.
+     *
+     * Turn it off when a row's height cannot be known up front and must not be
+     * clipped, such as a variable-height master-detail panel. Expect the DOM to
+     * hold every row when you do.
+     */
     virtualization?: boolean;
     /** Row height in pixels. Pass a function `(rowIndex) => px` for
      *  per-row variable heights (e.g. an interactive row-resize feature).
@@ -1221,6 +1303,11 @@ export type Props<TFeatures extends TableFeatures = TableFeatures, TData extends
      * to their content (the default). Does not affect the filter row.
      */
     headerHeight?: number;
+    /**
+     * Extra rows rendered above and below the viewport, so fast scrolling does
+     * not reach empty space before the next batch renders. Defaults to 8.
+     * Raise it for very tall rows, lower it to trim DOM work.
+     */
     overscan?: number;
     /**
      * Height of the grid's scrollable shell. A number is treated as pixels;
@@ -1228,8 +1315,24 @@ export type Props<TFeatures extends TableFeatures = TableFeatures, TData extends
      * make the grid fill its parent. Defaults to 520 px.
      */
     containerHeight?: number | string;
+    /**
+     * Render only the columns in view, the horizontal counterpart of
+     * `virtualization`. **On by default**, which is what makes a 100-column grid
+     * scroll smoothly.
+     *
+     * It recycles column DOM nodes, so it cannot coexist with sticky pinned
+     * columns - turn it off if you need pinning to survive horizontal scrolling.
+     */
     columnVirtualization?: boolean;
+    /**
+     * Extra columns rendered either side of the viewport when
+     * `columnVirtualization` is on. Defaults to 3.
+     */
     columnOverscan?: number;
+    /**
+     * Fallback width in pixels for columns whose `ColumnDef` sets no `width`.
+     * Defaults to 140.
+     */
     columnWidth?: number;
     /**
      * Columns pinned to the left/right edge on mount. Each entry is a
@@ -1262,8 +1365,24 @@ export type Props<TFeatures extends TableFeatures = TableFeatures, TData extends
     responsive?: boolean | {
         breakpoint?: number;
     };
+    /**
+     * @deprecated Has no effect - nothing in the grid reads this prop. It is kept
+     * only so existing code keeps compiling. The column menu's filter section is
+     * controlled by `showColumnFilters`, or by `filterMode="menu"` (the default).
+     */
     showFilterMenu?: boolean;
+    /**
+     * Show the always-visible filter row under the header. Explicitly setting
+     * this wins over `filterMode`; unset, it appears only when `filterMode` is
+     * `'row'`.
+     */
     showFilterRow?: boolean;
+    /**
+     * Cell selection - click to select, drag or shift-click to extend to a range,
+     * which is what clipboard copy and the range fill handle operate on. Unset,
+     * it follows `selectionMode` (default `'both'`, so this is on). `selectable`
+     * is the shortcut alias and wins over it.
+     */
     enableCellSelection?: boolean;
     /**
      * Highlight the row under the pointer. Default **false** - the hover tint can
@@ -1289,6 +1408,14 @@ export type Props<TFeatures extends TableFeatures = TableFeatures, TData extends
         rowIndex: number;
         columnId: string;
     }) => unknown;
+    /**
+     * Inline cell editing: F2 or double-click opens an editor in the active cell,
+     * Enter commits, Esc cancels. Off by default.
+     *
+     * A column still needs an `editorType` to pick its editor (text, number,
+     * date, checkbox, list, ...); without one it gets a plain text editor.
+     * `editable` is the shortcut alias and wins over this.
+     */
     enableInlineEditing?: boolean;
     /**
      * Full-row editing. When `true`, starting an edit puts the WHOLE row into
@@ -1298,7 +1425,22 @@ export type Props<TFeatures extends TableFeatures = TableFeatures, TData extends
      * text / number / date / datetime / checkbox / list-select editor types.
      */
     fullRowEditing?: boolean;
+    /**
+     * Append a sticky footer row aggregating every filtered row: the sum of a
+     * numeric column, `Count: N` otherwise. Choose a different aggregate per
+     * column with that column's own `summary` option, or set it to `false` there
+     * to leave the cell blank.
+     *
+     * Off by default. `summary` is the shortcut alias and wins when both are set.
+     *
+     *   <SvGrid {data} {columns} summary />
+     */
     enableRowSummaries?: boolean;
+    /**
+     * Shortcut alias for {@link enableRowSummaries}. Wins over it when both are
+     * set, the same precedence `selectable` has over `enableCellSelection`.
+     */
+    summary?: boolean;
     /**
      * Excel-style status bar under the grid showing live aggregates of the
      * selected cell range (count, numeric count, sum, average, min, max).
@@ -1514,6 +1656,14 @@ export type Props<TFeatures extends TableFeatures = TableFeatures, TData extends
      *   filter.
      */
     conditionalStatScope?: "filtered" | "visible" | "all";
+    /**
+     * Fires after an inline edit commits, with the cell's old and new value and
+     * the row it belongs to. This is where you persist the change.
+     *
+     * The grid has already applied the edit to its own state by the time this
+     * runs, so it is a notification, not a veto - reject a value with the
+     * column's `valueParser` or a validation rule instead.
+     */
     onCellValueChange?: (event: {
         rowIndex: number;
         columnId: string;

package/dist/ai.d.ts

@@ -34,6 +34,7 @@ type ExportFormat = 'xlsx' | 'xls' | 'pdf' | 'csv' | 'tsv' | 'html' | 'json' | '
  * provider eventually returns a string we can parse.
  */
 export type AIProvider = (request: AIRequest) => Promise<string>;
+/** One call out to the model, as the grid builds it. Providers receive this. */
 export type AIRequest = {
     /** Full prompt the grid built for the model. Already includes column
      *  schema and any sampled rows where applicable. */
@@ -51,6 +52,7 @@ export type AIRequest = {
      *  Useful for routing small jobs to a cheaper model. */
     maxOutputTokens?: number;
 };
+/** Which helper produced a request - carried on {@link AIRequest} for routing and telemetry. */
 export type AITask = 'filter' | 'smart-fill' | 'summarize' | 'classify' | 'export' | 'anomaly' | 'chart';
 /**
  * Register the model adapter every AI call will route through. Call once
@@ -58,17 +60,22 @@ export type AITask = 'filter' | 'smart-fill' | 'summarize' | 'classify' | 'expor
  * throwing "no provider" errors.
  */
 export declare function setAIProvider(p: AIProvider | null): void;
+/** The provider registered with `setAIProvider`, or null when none is. */
 export declare function getAIProvider(): AIProvider | null;
+/** Whether an AI provider is registered. Gate AI affordances on this so the UI stays honest. */
 export declare function hasAIProvider(): boolean;
+/** One condition in a filter plan: a column, a comparison, and the value to match. */
 export type AIFilterClause = {
     field: string;
     operator: 'contains' | 'equals' | 'startsWith' | 'greaterThan' | 'lessThan' | 'isBlank';
     value?: string;
 };
+/** One ordering clause in a filter plan. */
 export type AISortClause = {
     field: string;
     desc: boolean;
 };
+/** A natural-language query turned into filters and sorting, plus the model's reasoning. */
 export type AIFilterResult = {
     filters: AIFilterClause[];
     sort: AISortClause[];
@@ -76,6 +83,7 @@ export type AIFilterResult = {
      *  Surface this in the UI so the user can confirm or undo. */
     rationale: string;
 };
+/** Options for `aiFilter` - preview the plan, or apply it straight to the grid. */
 export type AIFilterOptions = {
     /**
      * When true, the helper not only RETURNS the plan but also applies it
@@ -92,10 +100,12 @@ export type AIFilterOptions = {
  * names without hallucinating.
  */
 export declare function aiFilter<TFeatures extends TableFeatures, TData extends RowData>(api: SvGridApi<TFeatures, TData>, query: string, opts?: AIFilterOptions): Promise<AIFilterResult>;
+/** One worked example teaching smart-fill what to produce for a row. */
 export type AISmartFillExample = {
     input: Record<string, unknown>;
     output: unknown;
 };
+/** Proposed values for the blank cells of one column, each with a confidence score. */
 export type AISmartFillResult<TValue = unknown> = {
     field: string;
     predictions: Array<{
@@ -105,6 +115,7 @@ export type AISmartFillResult<TValue = unknown> = {
     }>;
     rationale: string;
 };
+/** Options for `aiSmartFill` - which column to fill, which rows, and the examples to learn from. */
 export type AISmartFillOptions = {
     /** Target column - the one whose values we want filled. */
     field: string;
@@ -128,6 +139,7 @@ export type AISmartFillOptions = {
  * accept-per-cell UX with confidence-coloured highlights.
  */
 export declare function aiSmartFill<TFeatures extends TableFeatures, TData extends RowData, TValue = unknown>(api: SvGridApi<TFeatures, TData>, opts: AISmartFillOptions): Promise<AISmartFillResult<TValue>>;
+/** What to summarise: one row, the selection, a group, or the whole set. */
 export type AISummarizeTarget = {
     kind: 'row';
     rowIndex: number;
@@ -141,6 +153,7 @@ export type AISummarizeTarget = {
     field: string;
     value: unknown;
 };
+/** A generated summary: prose, bullets, and the columns the model leaned on. */
 export type AISummary = {
     text: string;
     bullets: string[];
@@ -148,6 +161,7 @@ export type AISummary = {
      *  story it just told. UI can highlight those columns. */
     highlightedFields: string[];
 };
+/** Options for `aiSummarize` - the target, and optionally the question to answer. */
 export type AISummarizeOptions = {
     target: AISummarizeTarget;
     /** Optional question the user is trying to answer. Helps the model
@@ -161,6 +175,7 @@ export type AISummarizeOptions = {
  * summary stays representative without blowing the context window.
  */
 export declare function aiSummarize<TFeatures extends TableFeatures, TData extends RowData>(api: SvGridApi<TFeatures, TData>, opts: AISummarizeOptions): Promise<AISummary>;
+/** Options for `aiClassify` - the column to label and the categories to choose from. */
 export type AIClassifyOptions = {
     /** Column whose free-text we're classifying. */
     inputField: string;
@@ -174,6 +189,7 @@ export type AIClassifyOptions = {
     targetRowIndices?: number[];
     signal?: AbortSignal;
 };
+/** Proposed category labels per row, with the model's reasoning. */
 export type AIClassifyResult = {
     inputField: string;
     outputField: string;
@@ -190,6 +206,7 @@ export type AIClassifyResult = {
  * values it can write straight back into the grid.
  */
 export declare function aiClassify<TFeatures extends TableFeatures, TData extends RowData>(api: SvGridApi<TFeatures, TData>, opts: AIClassifyOptions): Promise<AIClassifyResult>;
+/** An export the model derived from a request: format, columns, and scope. */
 export type AIExportPlan = {
     format: ExportFormat;
     filters: AIFilterClause[];
@@ -198,6 +215,7 @@ export type AIExportPlan = {
     /** Plain-English explanation of how the model read the request. */
     rationale: string;
 };
+/** Options for `aiExport` - preview the plan, or run the export it describes. */
 export type AIExportOptions = {
     /**
      * Also apply the filter / sort / grouping to the grid (mutating the view) so
@@ -219,6 +237,7 @@ export type AIExportOptions = {
  * so the UI can show what it did (or preview it first with `run: false`).
  */
 export declare function aiExport<TFeatures extends TableFeatures, TData extends RowData>(api: SvGridApi<TFeatures, TData>, query: string, opts?: AIExportOptions): Promise<AIExportPlan>;
+/** One flagged value, with why it stands out and how strongly. */
 export type AIAnomaly = {
     /** Index into the SCANNED rows (target order), when the model pins one row. */
     rowIndex?: number;
@@ -227,10 +246,12 @@ export type AIAnomaly = {
     reason: string;
     severity: 'low' | 'medium' | 'high';
 };
+/** Everything an anomaly scan flagged across the rows it looked at. */
 export type AIAnomalyResult = {
     anomalies: AIAnomaly[];
     summary: string;
 };
+/** Options for `aiFindAnomalies` - which rows and columns to scan. */
 export type AIAnomalyOptions = {
     /** Which rows to scan. Defaults to the whole dataset. */
     target?: AISummarizeTarget;
@@ -245,7 +266,9 @@ export type AIAnomalyOptions = {
  * export just those".
  */
 export declare function aiFindAnomalies<TFeatures extends TableFeatures, TData extends RowData>(api: SvGridApi<TFeatures, TData>, opts?: AIAnomalyOptions): Promise<AIAnomalyResult>;
+/** Chart shapes the model may choose from when planning a visualisation. */
 export type AIChartType = 'bar' | 'line' | 'area' | 'pie';
+/** A chart the model proposed: its type, and the fields to plot. */
 export type AIChartPlan = {
     type: AIChartType;
     /** Group-by (category-axis) column field, or null. */
@@ -261,6 +284,7 @@ export type AIChartPlan = {
     valueFormat: 'number' | 'currency' | 'percent';
     rationale: string;
 };
+/** Options for `aiChart` - preview the plan, or render it into the grid. */
 export type AIChartOptions = {
     /** Apply the plan to the grid's chart panel (open + configure). Default false. */
     apply?: boolean;
@@ -279,6 +303,10 @@ export declare function aiChart<TFeatures extends TableFeatures, TData extends R
  * calls this for you.
  */
 export declare function enableAiCharting<TFeatures extends TableFeatures, TData extends RowData>(api: SvGridApi<TFeatures, TData>): void;
+/**
+ * Remove the natural-language chart handler, hiding the AI button in the chart
+ * panel. The inverse of `enableAiCharting`; safe to call when none was set.
+ */
 export declare function disableAiCharting<TFeatures extends TableFeatures, TData extends RowData>(api: SvGridApi<TFeatures, TData>): void;
 /**
  * A deterministic provider that returns canned, schema-shaped responses

package/dist/ai.js

@@ -34,9 +34,11 @@ let provider = null;
 export function setAIProvider(p) {
     provider = p;
 }
+/** The provider registered with `setAIProvider`, or null when none is. */
 export function getAIProvider() {
     return provider;
 }
+/** Whether an AI provider is registered. Gate AI affordances on this so the UI stays honest. */
 export function hasAIProvider() {
     return provider != null;
 }
@@ -590,6 +592,10 @@ export function enableAiCharting(api) {
         };
     });
 }
+/**
+ * Remove the natural-language chart handler, hiding the AI button in the chart
+ * panel. The inverse of `enableAiCharting`; safe to call when none was set.
+ */
 export function disableAiCharting(api) {
     const hook = api;
     hook.setChartAiHandler?.(null);

package/dist/cdn/{GridMenus-B0F9iBrG.js → GridMenus-BfTAKn84.js}

@@ -1,4 +1,4 @@
-import { Kn as e, co as t, so as n } from "./src-Cd0tearp.js";
+import { Kn as e, co as t, so as n } from "./src-BYq-qyrp.js";
 import { E as r, F as i, G as a, H as o, I as s, L as c, N as l, Q as u, U as d, V as f, X as p, Y as m, Z as h, _ as g, d as _, et as v, f as y, ft as b, g as x, h as S, j as C, k as w, lt as T, m as E, mt as D, nt as O, o as k, pt as A, st as j, t as M, tt as N, u as P, ut as F, v as I } from "./disclose-version-Dr7rEVv-.js";
 import { b as ee } from "./editor-registry-CiI0xlKg.js";
 import { l as te } from "./SvDateTimePicker-CRQH_U7E.js";

package/dist/cdn/{GridMenus-IHK_l7m6.js → GridMenus-C3bJd7w8.js}

@@ -1,4 +1,4 @@
-import { Kn as e, co as t, so as n } from "./src-B1TdiyS8.js";
+import { Kn as e, co as t, so as n } from "./src-DBel9wRZ.js";
 import { b as r } from "./editor-registry-CiI0xlKg.js";
 import { l as i } from "./SvDateTimePicker-CHnUkWcH.js";
 import * as a from "svelte/internal/client";