@freegridjs/core 1.9.5 → 1.11.0

package/dist/{types-CIOv3MoN.d.ts → types-8dux3w2p.d.ts}

@@ -283,7 +283,7 @@ type EditorSpec = {
  | {
     type: 'datetime';
 } | ((params: EditorParams) => CustomEditor);
-type KeyAction = 'edit' | 'clear' | 'undo' | 'redo' | 'copy' | 'cut' | 'paste' | 'selectAll' | 'find' | 'none';
+type KeyAction = 'edit' | 'clear' | 'undo' | 'redo' | 'copy' | 'cut' | 'paste' | 'selectAll' | 'find' | 'columnMenu' | 'none';
 interface ColumnState {
     colId: string;
     width: number;
@@ -296,6 +296,10 @@ interface Messages {
     apply: string;
     reset: string;
     selectAll: string;
+    /** Filter row list when a set filter passes more than one value: '({n} selected)'. */
+    setSelected: string;
+    /** Column menu with rollup: the entry that removes a column's aggregate. */
+    noAggregate: string;
     search: string;
     blanks: string;
     value: string;
@@ -384,18 +388,6 @@ interface Messages {
     /** Context menu: download a PDF of the rows. */
     exportPdf: string;
     exportJson: string;
-    /** The assistant panel. */
-    ai: {
-        title: string;
-        placeholder: string;
-        send: string;
-        thinking: string;
-        undo: string;
-        undone: string;
-        failed: string;
-        skipped: string;
-        done: string;
-    };
     /** Conditional formatting dialog. */
     cf: {
         title: string;
@@ -602,118 +594,9 @@ interface ConditionalFormat {
     min?: number;
     max?: number;
 }
-/** The AI assistant: the grid asks your server, your server asks the model and answers with actions. */
-interface AssistantOptions {
-    /** Your endpoint (POST JSON). It holds the model API key; the browser never sees it. */
-    url: string;
-    headers?: Record<string, string> | (() => Record<string, string>);
-    credentials?: RequestCredentials;
-    /** Rows sent as examples (default 5, max 50; 0 sends none). Columns always go as summaries, not rows. */
-    sampleRows?: number;
-    /** Extra facts for the model, such as what the screen is for. */
-    context?: () => Record<string, unknown>;
-    /** Ideas shown under the input. */
-    suggestions?: string[];
-}
-/** A column as the assistant sees it. */
-interface AssistantColumn {
-    id: string;
-    header: string;
-    type?: string;
-    formula?: string;
-    aggFunc?: string;
-    hidden?: boolean;
-    blanks?: number;
-    distinct?: number;
-    min?: number | string;
-    max?: number | string;
-    avg?: number;
-    /** Most frequent values of text columns. */
-    top?: {
-        value: string;
-        count: number;
-    }[];
-}
-/** What the grid sends to the assistant endpoint. */
-interface AssistantRequest {
-    prompt: string;
-    locale: string;
-    /** Rows after the filters. */
-    rowCount: number;
-    totalRows: number;
-    columns: AssistantColumn[];
-    sample: Row[];
-    state: {
-        sort: SortItem[];
-        filters: Record<string, FilterModel>;
-        quickFilter: string;
-        advancedFilter: AdvancedFilter | null;
-        groupBy: string[];
-        pivot: PivotConfig | null;
-        conditionalFormats: ConditionalFormat[];
-    };
-    context?: Record<string, unknown>;
-}
-/** What the assistant endpoint answers with: { message?, actions? }. */
-type AssistantAction = {
-    type: 'sort';
-    sort: SortItem[];
-} | {
-    type: 'filter';
-    colId: string;
-    model: FilterModel | null;
-} | {
-    type: 'clearFilters';
-} | {
-    type: 'quickFilter';
-    text: string;
-} | {
-    type: 'advancedFilter';
-    filter: AdvancedFilter | null;
-} | {
-    type: 'groupBy';
-    colIds: string[];
-    expand?: boolean;
-} | {
-    type: 'pivot';
-    pivot: PivotConfig | null;
-} | {
-    type: 'showColumns' | 'hideColumns';
-    colIds: string[];
-} | {
-    type: 'conditionalFormat';
-    format: ConditionalFormat;
-} | {
-    type: 'clearConditionalFormats';
-} | {
-    type: 'addColumn';
-    column: {
-        id: string;
-        header?: string;
-        formula: string;
-        type?: 'number' | 'text' | 'date';
-    };
-} | {
-    type: 'summary';
-    summary: SummaryOptions | null;
-} | {
-    type: 'chart';
-    chartType?: ChartOptions['type'];
-    colIds: string[];
-    title?: string;
-} | {
-    type: 'message';
-    text: string;
-};
-interface AssistantResult {
-    message: string;
-    applied: AssistantAction[];
-    skipped: {
-        action: unknown;
-        reason: string;
-    }[];
-    /** Put the grid back as it was before these actions. */
-    undo(): void;
+interface RollupOptions {
+    /** Columns the rows merge by; only the shown ones count, so hiding one merges the rows by the rest. */
+    by: string[];
 }
 interface PivotConfig {
     /** Row fields; every field but the last becomes a group level. */
@@ -757,6 +640,16 @@ interface GridOptions {
     fontSize?: number;
     /** CSS font-family list (default: the theme's system font stack). */
     fontFamily?: string;
+    /** Space in px on the left and right inside every cell and header cell (default: the theme's, 12 at normal density). Wins over `density`. */
+    cellPadding?: number;
+    /**
+     * Merge rows by columns. `{ by: ['country', 'name', 'company'] }`: rows that agree on the shown `by` columns
+     * become one row; hide or remove one of them and the rows merge by the others, show it again and they split.
+     * `true`: every shown column without an `aggFunc` is a `by` column. Columns with an `aggFunc` show the aggregate
+     * of the merged rows; any other column shows its value when the merged rows share it, else stays empty. Merged
+     * rows cannot be edited. Change it later with setRollup; set a column's aggregate with setColumnAggFunc.
+     */
+    rollup?: boolean | RollupOptions;
     /** Dock a Columns panel on the right. `{ open: true }` starts expanded. */
     sideBar?: boolean | {
         open?: boolean;
@@ -810,8 +703,6 @@ interface GridOptions {
     editType?: 'cell' | 'row';
     /** Briefly highlight cells whose value changed through applyTransaction (default true). */
     flashCells?: boolean;
-    /** An AI assistant answered by your server (see AssistantOptions). */
-    assistant?: AssistantOptions;
     /** Rules that colour cells by their values, and data bars, colour scales and icon sets. */
     conditionalFormats?: ConditionalFormat[];
     /** Show "Conditional formatting…" in the column menu (default true). */
@@ -1009,16 +900,6 @@ interface GridEvents {
     conditionalFormatsChange: {
         formats: ConditionalFormat[];
     };
-    /** The assistant answered and its actions were applied. */
-    assistantAnswer: {
-        prompt: string;
-        message: string;
-        applied: AssistantAction[];
-        skipped: {
-            action: unknown;
-            reason: string;
-        }[];
-    };
     /** A row was dropped on this grid (also from another grid of the same drag group). */
     rowDrop: RowDropParams & {
         fromGrid: GridApi | null;
@@ -1125,10 +1006,6 @@ interface GridApi {
     flushAsyncTransactions(): void;
     setConditionalFormats(formats: ConditionalFormat[]): void;
     getConditionalFormats(): ConditionalFormat[];
-    /** Ask the assistant (options.assistant) and apply its answer. */
-    askAssistant(prompt: string): Promise<AssistantResult>;
-    /** The assistant panel. */
-    openAssistant(): void;
     /** The conditional formatting dialog for a column. */
     openConditionalFormats(colId: string): void;
     /** Conditions across columns, applied together with the column filters; null clears it. */
@@ -1185,6 +1062,15 @@ interface GridApi {
         size?: number;
         family?: string | null;
     }): void;
+    /** Left and right space inside every cell and header cell, in px; `null` goes back to the theme / density value. */
+    setCellPadding(px: number | null): void;
+    /** The cell padding in use, in px. */
+    getCellPadding(): number;
+    /** Change the `rollup` option: `{ by }`, `true`, or `false` for the original rows. */
+    setRollup(rollup: boolean | RollupOptions): void;
+    getRollup(): boolean | RollupOptions;
+    /** Set a column's aggregate (group rows, rollup); null removes it, so with rollup the rows merge by that column. */
+    setColumnAggFunc(colId: string, aggFunc: Aggregator | null): void;
     setColumnVisible(colId: string, visible: boolean): void;
     autoSizeColumns(colIds?: string[]): void;
     resetColumnState(): void;
@@ -1301,4 +1187,4 @@ interface GridApi {
     destroy(): void;
 }
 
-export { type SavedGridState as $, type AdvancedFilter as A, type EditorSpec as B, type CellEvent as C, type Datasource as D, type ExportOptions as E, type FilterModel as F, type GridOptions as G, type FilterOp as H, type FilterType as I, type GridEvents as J, type GridRange as K, type LocalePack as L, type InvalidCell as M, type JsonExportOptions as N, type KeyAction as O, type MergeSelectionGroup as P, type Messages as Q, type Row as R, type NumberFilterModel as S, type NumberOp as T, type PdfOptions as U, type PivotConfig as V, type PrintOptions as W, type Region as X, type RowDragOptions as Y, type RowDropParams as Z, type RowDropPosition as _, type GridApi as a, type SavedStatePart as a0, type ScrollPosition as a1, type SelectOption as a2, type ServerParams as a3, type SetFilterModel as a4, type SortDir as a5, type SortItem as a6, type SpanParams as a7, type SummaryCell as a8, type SummaryOptions as a9, type SummaryRowDef as aa, type TextFilterModel as ab, type TextOp as ac, type TransactionResult as ad, type XlsxCell as ae, type XlsxSheet as af, readXlsx as ag, writeXlsx as ah, type RowTransaction as b, type AdvancedFilterCondition as c, type Aggregator as d, type AssistantAction as e, type AssistantColumn as f, type AssistantOptions as g, type AssistantRequest as h, type AssistantResult as i, type CellParams as j, type CellStyle as k, type ChartHandle as l, type ChartOptions as m, type ColumnDef as n, type ColumnState as o, type ColumnType as p, type CombinedFilterModel as q, type ConditionalFormat as r, type ConditionalFormatType as s, type ConditionalOp as t, type ContextMenuItem as u, type ContextMenuParams as v, type CustomEditor as w, type DateFilterModel as x, type DateOp as y, type EditorParams as z };
+export { type ServerParams as $, type AdvancedFilter as A, type Messages as B, type CellEvent as C, type Datasource as D, type ExportOptions as E, type FilterModel as F, type GridOptions as G, type NumberOp as H, type InvalidCell as I, type JsonExportOptions as J, type KeyAction as K, type LocalePack as L, type MergeSelectionGroup as M, type NumberFilterModel as N, type PivotConfig as O, type PdfOptions as P, type PrintOptions as Q, type Row as R, type Region as S, type RollupOptions as T, type RowDragOptions as U, type RowDropParams as V, type RowDropPosition as W, type SavedGridState as X, type SavedStatePart as Y, type ScrollPosition as Z, type SelectOption as _, type GridApi as a, type SetFilterModel as a0, type SortDir as a1, type SortItem as a2, type SpanParams as a3, type SummaryCell as a4, type SummaryOptions as a5, type SummaryRowDef as a6, type TextFilterModel as a7, type TextOp as a8, type TransactionResult as a9, type XlsxCell as aa, type XlsxSheet as ab, readXlsx as ac, writeXlsx as ad, type RowTransaction as b, type AdvancedFilterCondition as c, type Aggregator as d, type CellParams as e, type CellStyle as f, type ChartHandle as g, type ChartOptions as h, type ColumnDef as i, type ColumnState as j, type ColumnType as k, type CombinedFilterModel as l, type ConditionalFormat as m, type ConditionalFormatType as n, type ConditionalOp as o, type ContextMenuItem as p, type ContextMenuParams as q, type CustomEditor as r, type DateFilterModel as s, type DateOp as t, type EditorParams as u, type EditorSpec as v, type FilterOp as w, type FilterType as x, type GridEvents as y, type GridRange as z };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@freegridjs/core",
-  "version": "1.9.5",
+  "version": "1.11.0",
   "description": "FreeGrid — a fast data grid for the web: virtual scrolling, grouping, pivot, charts, Excel export, 7 languages. Free core; paid features free with a personal key.",
   "license": "SEE LICENSE IN LICENSE",
   "type": "module",