@freegridjs/core 1.1.0 → 1.7.0

package/dist/index.d.ts

@@ -1,11 +1,11 @@
-import { G as GridOptions, a as GridApi, E as ExportOptions, R as Row, D as Datasource, L as LocalePack } from './types-BDvXVuCe.js';
-export { A as AdvancedFilter, b as AdvancedFilterCondition, c as Aggregator, C as CellEvent, d as CellParams, e as ChartHandle, f as ChartOptions, g as ColumnDef, h as ColumnState, i as ColumnType, j as CombinedFilterModel, k as ContextMenuItem, l as ContextMenuParams, m as CustomEditor, n as DateFilterModel, o as DateOp, p as EditorParams, q as EditorSpec, F as FilterModel, r as FilterOp, s as FilterType, t as GridEvents, u as GridRange, I as InvalidCell, K as KeyAction, M as Messages, N as NumberFilterModel, v as NumberOp, P as PivotConfig, w as PrintOptions, x as Region, y as RowDragOptions, z as RowDropParams, B as RowDropPosition, H as RowTransaction, S as SavedGridState, J as SavedStatePart, O as ScrollPosition, Q as SelectOption, T as ServerParams, U as SetFilterModel, V as SortDir, W as SortItem, X as SpanParams, Y as SummaryCell, Z as SummaryOptions, _ as SummaryRowDef, $ as TextFilterModel, a0 as TextOp, a1 as TransactionResult, a2 as XlsxCell, a3 as XlsxSheet, a4 as readXlsx, a5 as writeXlsx } from './types-BDvXVuCe.js';
+import { G as GridOptions, a as GridApi, E as ExportOptions, R as Row, D as Datasource, b as RowTransaction, L as LocalePack } from './types-DPOWDM8R.js';
+export { A as AdvancedFilter, c as AdvancedFilterCondition, d as Aggregator, e as AssistantAction, f as AssistantColumn, g as AssistantOptions, h as AssistantRequest, i as AssistantResult, C as CellEvent, j as CellParams, k as CellStyle, l as ChartHandle, m as ChartOptions, n as ColumnDef, o as ColumnState, p as ColumnType, q as CombinedFilterModel, r as ConditionalFormat, s as ConditionalFormatType, t as ConditionalOp, u as ContextMenuItem, v as ContextMenuParams, w as CustomEditor, x as DateFilterModel, y as DateOp, z as EditorParams, B as EditorSpec, F as FilterModel, H as FilterOp, I as FilterType, J as GridEvents, K as GridRange, M as InvalidCell, N as JsonExportOptions, O as KeyAction, P as Messages, Q as NumberFilterModel, S as NumberOp, T as PdfOptions, U as PivotConfig, V as PrintOptions, W as Region, X as RowDragOptions, Y as RowDropParams, Z as RowDropPosition, _ as SavedGridState, $ as SavedStatePart, a0 as ScrollPosition, a1 as SelectOption, a2 as ServerParams, a3 as SetFilterModel, a4 as SortDir, a5 as SortItem, a6 as SpanParams, a7 as SummaryCell, a8 as SummaryOptions, a9 as SummaryRowDef, aa as TextFilterModel, ab as TextOp, ac as TransactionResult, ad as XlsxCell, ae as XlsxSheet, af as readXlsx, ag as writeXlsx } from './types-DPOWDM8R.js';
 export { default as en } from './locales/en.js';
 
 declare function createGrid(host: HTMLElement, options: GridOptions): GridApi;
 
 /** FreeGrid version (kept in sync with releases.json by scripts/release.mjs). */
-declare const version = "1.1.0";
+declare const version = "1.7.0";
 
 interface LicenseInfo {
     /** Licensed domains (plus their www. host); `*.example.com` also covers every subdomain. */
@@ -14,19 +14,22 @@ interface LicenseInfo {
     /** Last valid day, YYYY-MM-DD. */
     expires: string;
     issued: string;
+    /** Perpetual keys: the major version they cover (bought on 1.x → every 1.x release). Absent: every version while valid. */
+    major?: number;
 }
 type LicenseResult = {
     ok: true;
     info: LicenseInfo;
 } | {
     ok: false;
-    reason: 'format' | 'signature' | 'expired' | 'domain' | 'unsupported';
+    reason: 'format' | 'signature' | 'expired' | 'domain' | 'version' | 'unsupported';
     info?: LicenseInfo;
 };
-/** Check a key's signature, expiry and domain. */
+/** Check a key's signature, expiry, domain and (perpetual keys) the major version. */
 declare function verifyLicense(key: string, host: string, opts?: {
     publicKey?: JsonWebKey;
     now?: Date;
+    version?: string;
 }): Promise<LicenseResult>;
 /** Set the license key once for every grid on the page. */
 declare function setLicenseKey(key: string): void;
@@ -84,6 +87,79 @@ declare function loadData(grid: GridApi, url: string, options?: RestOptions & {
 /** Spring Security CSRF header from <meta name="_csrf"> and <meta name="_csrf_header">; empty when absent. */
 declare function csrfHeaders(doc?: Document): Record<string, string>;
 
+type LiveStatus = 'connecting' | 'open' | 'paused' | 'closed' | 'error';
+interface LiveOptions {
+    /** ws:// or wss:// opens a WebSocket; any other URL an EventSource (server-sent events). */
+    url?: string;
+    /** Or poll: called every `interval` ms; its result is handled like a message. */
+    poll?: () => unknown | Promise<unknown>;
+    /** Polling interval in ms (default 2000). */
+    interval?: number;
+    /** Turn a message into a transaction. Default: JSON text; an array of rows is an upsert; { rows } replaces the data. */
+    parse?: (message: unknown) => RowTransaction | Row[] | {
+        rows: Row[];
+    } | null | undefined;
+    /** Reconnect with a growing delay after the connection drops (default true). */
+    reconnect?: boolean;
+    /** Longest wait between reconnects in ms (default 30000). */
+    maxDelay?: number;
+    /** Apply right away instead of batching (applyTransactionAsync) — default false. */
+    immediate?: boolean;
+    /** WebSocket subprotocols. */
+    protocols?: string | string[];
+    /** EventSource: send cookies to another origin. */
+    withCredentials?: boolean;
+    /** EventSource event name to listen to (default 'message'). */
+    event?: string;
+    onStatus?: (status: LiveStatus) => void;
+    /** A message that could not be read. */
+    onError?: (error: unknown) => void;
+}
+interface LiveConnection {
+    readonly status: LiveStatus;
+    /** Hold updates (they are kept and applied on resume). */
+    pause(): void;
+    resume(): void;
+    close(): void;
+    /** Send a text message (WebSocket only). */
+    send(data: string): boolean;
+}
+/** The default reading of a message. */
+declare function messageToTransaction(message: unknown): RowTransaction | {
+    rows: Row[];
+} | null;
+/**
+ * Keep a grid up to date from a WebSocket, server-sent events or polling.
+ * Messages: an array of rows (updated by id, added when new), { add, update, remove, upsert }, or { rows } for all rows.
+ * The grid needs getRowId.
+ */
+declare function connectLive(api: GridApi, options: LiveOptions): LiveConnection;
+
+/**
+ * Remembers the last value given for an option. Framework wrappers use it so that a parent writing
+ * `groupBy={['country']}` inline (a new array on every render) applies it only when its content changes.
+ */
+declare function changeTracker(initial: unknown): (next: unknown) => boolean;
+
+/** Add a function formulas can call, e.g. registerFormulaFunction('VAT', ([n]) => Number(n) * 0.1). */
+declare function registerFormulaFunction(name: string, fn: (args: unknown[]) => unknown): void;
+/** Names of every function formulas can call. */
+declare function formulaFunctions(): string[];
+/** What a formula can see beyond its own row; the grid provides one per column set. */
+interface FormulaScope {
+    /** Every data row in source order. */
+    rows(): Row[];
+    /** Changes whenever any value may have changed. */
+    version(): number;
+    /** Formula of a computed column (columns with `formula` and no field), by column id. */
+    computed(name: string): string | undefined;
+}
+/**
+ * Value of `formula` (starting with '=') for `row`, or an error code like '#REF!'.
+ * `memo` holds the fields already worked out in this evaluation, so a=b+b, b=c+c, … stays linear.
+ */
+declare function evaluateFormula(formula: string, row: Row, seen?: Set<string>, depth?: number, memo?: Map<string, unknown>, scope?: FormulaScope | null): unknown;
+
 /** Dependency-free SVG charts: grouped or stacked bars, lines, areas, pies and donuts, bar + line combos and scatter plots. */
 type ChartType = 'bar' | 'stackedBar' | 'line' | 'area' | 'pie' | 'donut' | 'combo' | 'scatter';
 interface ChartSpec {
@@ -103,4 +179,4 @@ declare function renderChart(el: HTMLElement, spec: ChartSpec): void;
 declare function registerLocale(pack: LocalePack): void;
 declare function resolveLocale(input?: string | Partial<LocalePack>, navLangs?: readonly string[]): LocalePack;
 
-export { type ChartSpec, type ChartType, Datasource, ExportOptions, GridApi, GridOptions, type LicenseInfo, LocalePack, type RestOptions, Row, type WorkbookSheet, buildWorkbook, createGrid, csrfHeaders, exportWorkbook, loadData, parseCsv, registerLocale, renderChart, resolveLocale, restDatasource, saveChanges, setLicenseKey, verifyLicense, version };
+export { type ChartSpec, type ChartType, Datasource, ExportOptions, GridApi, GridOptions, type LicenseInfo, type LiveConnection, type LiveOptions, type LiveStatus, LocalePack, type RestOptions, Row, RowTransaction, type WorkbookSheet, buildWorkbook, changeTracker, connectLive, createGrid, csrfHeaders, evaluateFormula, exportWorkbook, formulaFunctions, loadData, messageToTransaction, parseCsv, registerFormulaFunction, registerLocale, renderChart, resolveLocale, restDatasource, saveChanges, setLicenseKey, verifyLicense, version };