@svgrid/grid 2.6.20 → 2.6.22

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);