@guiexpert/table 1.1.89 → 1.1.90

package/lib/table/data/options/table-options.d.ts

@@ -44,6 +44,13 @@ export declare class TableOptions implements TableOptionsIf {
     shortcutActionsDisabled: boolean;
     resizeEventDebounceDelay: number;
     getEditRenderer?: GetEditRenderer;
+    /**
+     * Selection model of the table. Not set (default): every table creates its own model
+     * (`new SelectionModel()`, type "none") – tables never share a selection.
+     */
     getSelectionModel?: GetT<SelectionModelIf>;
+    /**
+     * Focus model of the table. Not set (default): every table creates its own `new FocusModel("cell")`.
+     */
     getFocusModel?: GetT<FocusModelIf>;
 }

package/lib/table/factory/tree-factory.d.ts

@@ -1,7 +1,42 @@
 import { TreeRowIf } from '../data/common/tree-row-if';
 
+/**
+ * Expanded state of a new tree row: a fixed value for all rows, or a function per row
+ * (e.g. `(_data, deep) => deep < 1` → only the top level is open).
+ */
+export type TreeRowExpandedFn<T> = (data: T, deep: number) => boolean;
+/**
+ * Options for {@link TreeFactory.buildTreeRows}.
+ *
+ * @example
+ * // start with every node collapsed
+ * TreeFactory.buildTreeRows(data, { childrenProperty: "children", expanded: false });
+ *
+ * @example
+ * // open the first level only
+ * TreeFactory.buildTreeRows(data, { expanded: (_row, deep) => deep === 0 });
+ */
+export interface TreeFactoryOptions<T> {
+    /** Property that holds the child objects. Default: "children". */
+    childrenProperty?: string;
+    /** Expanded state of the rows. Default: true (everything open, as before). */
+    expanded?: boolean | TreeRowExpandedFn<T>;
+    /** Maximum depth. Default: 12. */
+    deepMaxLimit?: number;
+}
 export declare class TreeFactory {
-    static buildTreeRows<T>(data: T[], childrenProperty?: string, deepMaxLimit?: number): TreeRowIf<T>[];
-    static buildTreeRow<T>(data: T, childrenProperty?: string, parent?: TreeRowIf<T>, //, false , '0', '0'),
-    deep?: number, deepMaxLimit?: number): TreeRowIf<T>;
+    /**
+     * Builds tree rows (input for `TableFactory.createTableModel({ rows })`) from nested objects.
+     *
+     * @param data - the top-level objects
+     * @param childrenPropertyOrOptions - name of the children property (default "children") or {@link TreeFactoryOptions}
+     * @param deepMaxLimit - maximum depth (default 12; ignored when options are passed)
+     * @param expanded - expanded state of the rows (default true; ignored when options are passed)
+     *
+     * @example
+     * const rows = TreeFactory.buildTreeRows<OrderNode>(data, { childrenProperty: "children", expanded: false });
+     */
+    static buildTreeRows<T>(data: T[], childrenPropertyOrOptions?: string | TreeFactoryOptions<T>, deepMaxLimit?: number, expanded?: boolean | TreeRowExpandedFn<T>): TreeRowIf<T>[];
+    static buildTreeRow<T>(data: T, childrenProperty?: string, parent?: TreeRowIf<T>, deep?: number, deepMaxLimit?: number, expanded?: boolean | TreeRowExpandedFn<T>): TreeRowIf<T>;
+    private static toExpandedFn;
 }

package/lib/table/service/excel-service.d.ts

@@ -10,11 +10,28 @@ export declare class ExcelService implements ExcelServiceIf {
      * @return {void} Does not return a value.
      * @throws {Error} Throws an error if the input matrix is not a valid 2D array or if the filename is an empty string.
      */
-    downloadExcel(matrix: Array<Array<any>>, filename?: string, author?: string): void;
+    downloadExcel(matrix: Array<Array<any>>, filename?: string, author?: string): Promise<void>;
+    /**
+     * Creates the .xlsx file as a Blob (compressed), e.g. to upload it instead of downloading it.
+     *
+     * @example
+     * const blob = await new ExcelService().createExcelBlob([["Name", "City"], ["Ann", "Berlin"]]);
+     * await fetch("/api/upload", { method: "POST", body: blob });
+     */
+    createExcelBlob(matrix: Array<Array<any>>, author?: string): Promise<Blob>;
     private generateMap;
     private getX1WorksheetsSheet1Xml;
     private escapeXml;
     private getCellAddress;
+    /**
+     * ZIP without compression (method 0, synchronous). Kept for compatibility –
+     * downloads use {@link createZipCompressed}.
+     */
     createZip(files: Map<string, string>): Uint8Array;
-    private generateBuffer;
+    /**
+     * ZIP with DEFLATE (method 8) via the browser's CompressionStream; falls back to stored entries
+     * where that is not available. 100,000 rows × 7 columns: ~40 MB stored → a few MB compressed.
+     */
+    createZipCompressed(files: Map<string, string>): Promise<Uint8Array>;
+    private assembleZip;
 }

package/lib/table/service/excel-service.if.d.ts

@@ -1,3 +1,3 @@
 export interface ExcelServiceIf {
-    downloadExcel(matrix: Array<Array<any>>, filename: string, author?: string): void;
+    downloadExcel(matrix: Array<Array<any>>, filename: string, author?: string): void | Promise<void>;
 }

package/lib/table/table-api.d.ts

@@ -1,3 +1,4 @@
+import { SortState } from './data/common/sort-state.type';
 import { TableScope } from './table-scope';
 import { ColumnDefIf } from './data/tablemodel/column/column-def.if';
 import { TableCellUpdateEventIf } from './data/common/event/input/table-cell-update-event.if';
@@ -925,7 +926,7 @@ export declare class TableApi {
      * @param {string} fileName - The name of the Excel file to be downloaded (default: 'table.xlsx')
      * @param {string} author - Optional metadata for the Excel file to specify the author (default: '')
      *
-     * @returns {void} The result of the excelService.downloadExcel method call
+     * @returns {Promise<void>} resolves when the (compressed) file has been handed to the browser
      *
      * @example
      * // Download table data with default filename
@@ -939,7 +940,7 @@ export declare class TableApi {
      * // Download table data with custom filename only
      * tableApi.downloadExcel('quarterly-data.xlsx');
      */
-    downloadExcel(fileName?: string, author?: string): void;
+    downloadExcel(fileName?: string, author?: string): void | Promise<void>;
     /**
      * Returns the TableScope instance associated with this TableApi.
      *
@@ -1258,6 +1259,18 @@ export declare class TableApi {
      * @throws {Warning} Logs a console warning if the table's body model is not an AreaModelObjectArray
      */
     updateRows<T>(rows: T[], predicate?: (a: T, b: T) => boolean): void;
+    /**
+     * Sorts by one column from code – e.g. from your own button – exactly like a double click on the
+     * column header: rows, header icon, filter (sort order survives filtering) and auto-restore.
+     *
+     * @param {number | string} column - column index or property, e.g. `"total"`
+     * @param {SortState} [sortState] - `"asc"` or `"desc"`; omitted: toggles like the header (asc → desc → …)
+     * @returns {boolean} false if the column does not exist
+     *
+     * @example
+     * document.querySelector("#by-total")!.addEventListener("click", () => tableApi.sortByColumn("total", "desc"));
+     */
+    sortByColumn(column: number | string, sortState?: SortState): boolean;
     /**
      * Re-applies the current sorting configuration to the table data.
      *

package/lib/table/table-scope.d.ts

@@ -6,6 +6,7 @@ import { TableOptionsIf } from './data/options/table-options.if';
 import { MouseHandler } from './mouse-handler';
 import { EventListenerIf } from './event-listener.if';
 import { TableApi } from './table-api';
+import { SortState } from './data/common/sort-state.type';
 import { StoreStateCollapsedExpandService } from './service/store-state-collapsed-expand.service';
 import { StoreStateSortingService } from './service/store-state-sorting.service';
 import { RenderScope } from './render-scope';
@@ -233,6 +234,16 @@ export declare class TableScope extends RenderScope implements OnActionTriggered
      * @return {void}
      */
     onHeaderDblClicked(event: MouseEvent, _rowIdx: number, colIdx: number): void;
+    /**
+     * Sorts the body by one column – the same as a double click on its header (header icon, filter and
+     * auto-restore included). Without `sortState` the next state of the column's sort order is used
+     * (asc → desc → asc …).
+     *
+     * @param {number | string} column - column index or property, e.g. 10 or "total"
+     * @param {SortState} [sortState] - "asc", "desc" or "" (unsorted icon, rows keep their current order)
+     * @returns {boolean} false if the column does not exist
+     */
+    sortByColumn(column: number | string, sortState?: SortState): boolean;
     /**
      * Scrolls the viewport to the specified pixel coordinates.
      *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@guiexpert/table",
-  "version": "1.1.89",
+  "version": "1.1.90",
   "license": "MIT",
   "author": "Dr. Marc Kronberg <info@gui.expert> (https://gui.expert)",
   "repository": {