eru-grid 0.0.37 → 0.0.38

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eru-grid",
-  "version": "0.0.37",
+  "version": "0.0.38",
   "peerDependencies": {
     "@angular/common": "^21.1.2",
     "@angular/core": "^21.1.2",

package/types/eru-grid.d.ts

@@ -69,6 +69,26 @@ interface GridFeatures {
     actionColumnPosition?: 'before' | 'after';
     designMode?: boolean;
     groupBar?: boolean;
+    excel_download?: boolean;
+    response_key?: string;
+    header_fill_color?: string[];
+    header_fill_type?: string;
+    header_fill_pattern?: number;
+    header_font_family?: string;
+    header_font_size?: number;
+    header_font_bold?: boolean;
+    header_border_type?: string;
+    header_border_color?: string;
+    header_border_style?: number;
+    data_fill_color?: string[];
+    data_fill_type?: string;
+    data_fill_pattern?: number;
+    data_font_family?: string;
+    data_font_size?: number;
+    data_font_bold?: boolean;
+    data_border_type?: string;
+    data_border_color?: string;
+    data_border_style?: number;
     wrapHeaders?: boolean;
     headerRowHeight?: number;
     dataRowHeight?: number;
@@ -79,6 +99,64 @@ interface GridFeatures {
     boardColumnMinWidth?: number;
     boardColumnHeight?: number;
 }
+interface ExcelDownloadPayload {
+    columns: Record<string, {
+        headers: Record<string, {
+            max_width: number;
+            sub_total: boolean;
+            header_label: string;
+            header_name: string;
+        }>;
+    }>;
+    excel_styles: Record<string, {
+        header_style: {
+            fill: {
+                color: string[];
+                type: string;
+                pattern: number;
+            };
+            font: {
+                family: string;
+                size: number;
+                bold: boolean;
+            };
+            border: [{
+                type: string;
+                color: string;
+                style: number;
+            }];
+        };
+        data_style: {
+            fill: {
+                color: string[];
+                type: string;
+                pattern: number;
+            };
+            font: {
+                family: string;
+                size: number;
+                bold: boolean;
+            };
+            border: [{
+                type: string;
+                color: string;
+                style: number;
+            }];
+        };
+    }>;
+}
+/**
+ * Descriptor enqueued by the grid when the excel-download icon is clicked.
+ * Consumers listen to EruGridStore.excelDownloadRequest() the same way they
+ * already listen to requestQueue()/dynamicDataRequest() — same
+ * enqueue/drain/remove pattern, not a one-off output event — and remove the
+ * request via EruGridStore.removeExcelDownloadRequest(id) once the file has
+ * been fetched and downloaded.
+ */
+interface ExcelDownloadRequest extends ExcelDownloadPayload {
+    id: number;
+    timestamp: number;
+}
 interface GridStyles {
     subTotalStyle?: 'bold' | 'italic' | 'highlighted';
     grandTotalStyle?: 'bold' | 'italic' | 'highlighted';
@@ -608,6 +686,7 @@ declare class EruGridStore {
     private readonly _sortColumns;
     private readonly _dataRequest;
     private readonly _requestQueue;
+    private readonly _excelDownloadRequest;
     private readonly _selectedDesignColumn;
     readonly selectedDesignColumn: _angular_core.Signal<string | null>;
     private readonly _columnDesignUpdate;
@@ -645,6 +724,7 @@ declare class EruGridStore {
     readonly dataRequest: _angular_core.Signal<RowDataRequest | null>;
     readonly dynamicDataRequest: _angular_core.Signal<DynamicDataRequest[] | null>;
     readonly dynamicData: _angular_core.Signal<Map<string, any> | null>;
+    readonly excelDownloadRequest: _angular_core.Signal<ExcelDownloadRequest[]>;
     readonly selectedRows: _angular_core.Signal<Row[]>;
     readonly totalSelectedCount: _angular_core.Signal<number>;
     readonly hasSelection: _angular_core.Signal<boolean>;
@@ -781,6 +861,16 @@ declare class EruGridStore {
      * Clear all requests from queue
      */
     clearRequestQueue(): void;
+    /**
+     * Enqueue an excel-download request (called by the grid component when the
+     * excel-download icon is clicked).
+     */
+    addExcelDownloadRequest(request: ExcelDownloadRequest): void;
+    /**
+     * Remove an excel-download request from the queue (called by the consumer
+     * once it has fetched and downloaded the file for that request).
+     */
+    removeExcelDownloadRequest(id: number): void;
     /**
      * Clear the data request signal (called by consumer after handling)
      */
@@ -1046,6 +1136,18 @@ declare class EruGridComponent implements OnInit, AfterViewInit, OnDestroy {
         group?: RowGroup;
     }>;
     emitRowSelect(row: Row, mode: 'table' | 'board', group?: RowGroup): void;
+    /**
+     * Fires when the user clicks the excel download icon (shown when
+     * `config.excel_download` is enabled). Enqueues an ExcelDownloadRequest
+     * onto gridStore.excelDownloadRequest() — the same enqueue/drain/remove
+     * pattern already used for row-data pagination (requestQueue) and cell
+     * option-lists (dynamicDataRequest) — rather than a one-off output event.
+     * The consumer's effect drains the queue, performs its own entity/query
+     * fetch (the library never makes HTTP calls itself), and removes the
+     * request via gridStore.removeExcelDownloadRequest(id) once done.
+     */
+    onExcelDownloadClick(event: Event): void;
+    private buildExcelDownloadPayload;
     /** Whether a board card is the active (last-clicked) one. Compared by row
      *  reference so it works for entity and query data alike. */
     isBoardCardActive(row: Row): boolean;
@@ -1080,6 +1182,7 @@ declare class EruGridComponent implements OnInit, AfterViewInit, OnDestroy {
     isSortable: _angular_core.Signal<boolean>;
     showSortBar: _angular_core.Signal<boolean>;
     showGroupBar: _angular_core.Signal<boolean>;
+    showExcelDownload: _angular_core.Signal<boolean>;
     wrapHeaders: _angular_core.Signal<boolean>;
     headerRowHeight: _angular_core.Signal<number>;
     dataRowHeight: _angular_core.Signal<number>;
@@ -2307,4 +2410,4 @@ declare class ThemeToggleComponent {
 }
 
 export { AttachmentComponent, CheckboxComponent, ColumnConstraintsService, CurrencyComponent, CustomVirtualScrollStrategy, DATA_TYPES, DateComponent, DatetimeComponent, DurationComponent, EmailComponent, EruGridComponent, EruGridService, EruGridStore, LocationComponent, MATERIAL_MODULES, MATERIAL_PROVIDERS, NumberComponent, PRESET_CONFIG_DEFAULTS, PRESET_MANAGED_FIELDS, PeopleComponent, PhoneComponent, PriorityComponent, ProgressComponent, RatingComponent, SelectComponent, StatusComponent, TagComponent, TextareaComponent, TextboxComponent, ThemeService, ThemeToggleComponent, WebsiteComponent };
-export type { ActionClick, AggregationFunction, AttachmentConfig, BoardCardContext, CellValueChange, ColumnReorder, ColumnResize, ColumnWidthConstraints, CurrencyValidationResult, DataTypes, Drilldown, DurationValue, DynamicDataRequest, EmailValidationResult, Field, GridConfiguration, GridFeatures, GridMode, GridPreset, GridStyles, GridTokens, GroupItem$1 as GroupItem, LocationConfig, LocationValidationResult, NumberValidationResult, PeopleOption, PivotColumnGroupState, PivotColumnHeader, PivotConfiguration, PivotHeaderStructure, PivotMetadata, PivotResult, PivotRow, RatingConfig, Row, RowDataRequest, RowDataResponse, RowGrandTotal, RowGroup, TextareaValidationResult, TextboxValidationResult, Theme, WebsiteValidationResult };
+export type { ActionClick, AggregationFunction, AttachmentConfig, BoardCardContext, CellValueChange, ColumnReorder, ColumnResize, ColumnWidthConstraints, CurrencyValidationResult, DataTypes, Drilldown, DurationValue, DynamicDataRequest, EmailValidationResult, ExcelDownloadPayload, ExcelDownloadRequest, Field, GridConfiguration, GridFeatures, GridMode, GridPreset, GridStyles, GridTokens, GroupItem$1 as GroupItem, LocationConfig, LocationValidationResult, NumberValidationResult, PeopleOption, PivotColumnGroupState, PivotColumnHeader, PivotConfiguration, PivotHeaderStructure, PivotMetadata, PivotResult, PivotRow, RatingConfig, Row, RowDataRequest, RowDataResponse, RowGrandTotal, RowGroup, TextareaValidationResult, TextboxValidationResult, Theme, WebsiteValidationResult };