@freegridjs/core 0.8.1 → 1.0.1

package/dist/index.d.ts

@@ -1,11 +1,11 @@
-import { G as GridOptions, a as GridApi, L as LocalePack } from './types-e45suTSB.js';
-export { A as Aggregator, C as CellEvent, b as CellParams, c as ChartHandle, d as ChartOptions, e as ColumnDef, f as ColumnState, g as ColumnType, h as ContextMenuItem, i as ContextMenuParams, j as CustomEditor, D as Datasource, k as DateFilterModel, l as DateOp, E as EditorParams, m as EditorSpec, n as ExportOptions, F as FilterModel, o as FilterOp, p as FilterType, q as GridEvents, r as GridRange, I as InvalidCell, K as KeyAction, M as Messages, N as NumberFilterModel, s as NumberOp, P as PivotConfig, R as Region, t as Row, u as RowDragOptions, v as RowDropParams, w as RowDropPosition, S as ScrollPosition, x as SelectOption, y as ServerParams, z as SetFilterModel, B as SortDir, H as SortItem, J as SpanParams, O as SummaryCell, Q as SummaryOptions, T as SummaryRowDef, U as TextFilterModel, V as TextOp } from './types-e45suTSB.js';
+import { G as GridOptions, a as GridApi, E as ExportOptions, R as Row, D as Datasource, L as LocalePack } from './types-bFz-Q6ac.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 Region, x as RowDragOptions, y as RowDropParams, z as RowDropPosition, B as RowTransaction, S as SavedGridState, H as SavedStatePart, J as ScrollPosition, O as SelectOption, Q as ServerParams, T as SetFilterModel, U as SortDir, V as SortItem, W as SpanParams, X as SummaryCell, Y as SummaryOptions, Z as SummaryRowDef, _ as TextFilterModel, $ as TextOp, a0 as TransactionResult, a1 as XlsxCell, a2 as XlsxSheet, a3 as readXlsx, a4 as writeXlsx } from './types-bFz-Q6ac.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 = "0.8.1";
+declare const version = "1.0.1";
 
 interface LicenseInfo {
     /** Licensed domains (plus their www. host); `*.example.com` also covers every subdomain. */
@@ -31,44 +31,61 @@ declare function verifyLicense(key: string, host: string, opts?: {
 /** Set the license key once for every grid on the page. */
 declare function setLicenseKey(key: string): void;
 
-/** A cell value, optionally with an Excel number format and text styles. Colors are ARGB hex like 'FFDC2626'. */
-type XlsxValue = string | number | boolean | Date | null | undefined;
-interface XlsxStyle {
-    fmt?: string;
-    bold?: boolean;
-    align?: 'left' | 'center' | 'right';
-    color?: string;
-    fill?: string;
-    /** Header look: bold on a light gray fill. */
-    header?: boolean;
-}
-type XlsxCell = XlsxValue | ({
-    v: XlsxValue;
-} & XlsxStyle);
-interface XlsxSheet {
-    name?: string;
-    rows: XlsxCell[][];
-    /** Column widths in characters. */
-    widths?: number[];
-    /** Ranges like "A1:C1". */
-    merges?: string[];
-    /** Rows frozen at the top (also the AutoFilter row when `autoFilter` is set). */
-    freezeRows?: number;
-    autoFilter?: boolean;
-}
-/** Build an .xlsx workbook (stored zip) from rows of values. */
-declare function writeXlsx(sheets: XlsxSheet[]): Uint8Array;
-interface ReadSheet {
-    name: string;
-    rows: XlsxValue[][];
+declare function parseCsv(text: string, sep?: string): string[][];
+
+interface WorkbookSheet {
+    grid: GridApi;
+    sheetName?: string;
+    options?: ExportOptions;
 }
-/** Read every sheet of an .xlsx file. Dates come back as Date, numbers as number, booleans as boolean. */
-declare function readXlsx(input: ArrayBuffer | Uint8Array): Promise<ReadSheet[]>;
+/** One .xlsx file with a sheet per grid (each with its own columns, rows and options). */
+declare function buildWorkbook(sheets: WorkbookSheet[]): Uint8Array;
+/** Download buildWorkbook(sheets) as `filename`. */
+declare function exportWorkbook(filename: string, sheets: WorkbookSheet[]): void;
 
-declare function parseCsv(text: string, sep?: string): string[][];
+/**
+ * Server helpers for REST back ends (Spring Boot, eGovFrame, Express…).
+ *
+ * Request (POST JSON, or GET query): { start, end, page, size, sort: [{ colId, dir }], filters, quickFilter,
+ *   advancedFilter?, groupBy?, groupKeys?, ...params }
+ * Response: { rows, total } — also { list, totalCount }, { content, totalElements } (Spring Page) or { data, total }.
+ */
+interface RestOptions {
+    /** 'POST' (default) sends JSON; 'GET' puts the request in the query string. */
+    method?: 'GET' | 'POST';
+    /** Extra headers (for example csrfHeaders()); a function is called for every request. */
+    headers?: Record<string, string> | (() => Record<string, string>);
+    /** Default 'same-origin' so session cookies go along. */
+    credentials?: RequestCredentials;
+    /** Extra fields sent with every request, such as the values of a search form. */
+    params?: () => Record<string, unknown>;
+    /** Turn the server's JSON into { rows, total } when it uses other names. */
+    transform?: (json: unknown) => {
+        rows: Row[];
+        total?: number;
+    };
+}
+/** A datasource that asks your server for each block of rows. */
+declare function restDatasource(url: string, options?: RestOptions): Datasource;
+/**
+ * POST { created, updated, deleted } (from getModifiedRows) to `url`. On success the sent changes become the new
+ * baseline (commitChanges) and the server's JSON is returned; on failure it throws and the changes stay.
+ * Nothing is sent when there are no changes. While a save is in flight, calling again returns that same save;
+ * edits made meanwhile stay changes for the next save.
+ */
+declare function saveChanges(grid: GridApi, url: string, options?: Omit<RestOptions, 'method' | 'transform'>): Promise<unknown>;
+/**
+ * The "search, edit, save" screen: fetch every matching row once (same request as restDatasource, rows 0..maxRows)
+ * and put them in the grid with setData, so rows can be added, deleted, sorted and filtered in the browser.
+ */
+declare function loadData(grid: GridApi, url: string, options?: RestOptions & {
+    maxRows?: number;
+}): Promise<Row[]>;
+/** Spring Security CSRF header from <meta name="_csrf"> and <meta name="_csrf_header">; empty when absent. */
+declare function csrfHeaders(doc?: Document): Record<string, string>;
 
-/** Dependency-free SVG charts: grouped or stacked bars, lines, areas and pies. */
-type ChartType = 'bar' | 'stackedBar' | 'line' | 'area' | 'pie';
+/** 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 {
     type: ChartType;
     categories: string[];
@@ -86,4 +103,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, GridApi, GridOptions, type LicenseInfo, LocalePack, type XlsxCell, type XlsxSheet, createGrid, parseCsv, readXlsx, registerLocale, renderChart, resolveLocale, setLicenseKey, verifyLicense, version, writeXlsx };
+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 };