@cauca-911/datagrid 22.2.1 → 22.2.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cauca-911/datagrid",
-  "version": "22.2.1",
+  "version": "22.2.3",
   "peerDependencies": {
     "@angular/common": ">=22.1.0",
     "@angular/core": ">=22.1.0",

package/types/cauca-911-datagrid.d.ts

@@ -52,6 +52,13 @@ declare abstract class BaseGridColumnComponent implements OnDestroy, OnInit {
 }
 
 type GridExportFormat = 'excel' | 'pdf';
+declare const ALL_EXPORT_FORMATS: readonly GridExportFormat[];
+interface ExportMatrix {
+    headers: string[];
+    rows: ExportCell[][];
+}
+declare const GRID_OWNED_COLUMNS: readonly string[];
+declare function buildExportMatrix(columnOrder: readonly string[], columns: readonly BaseGridColumnComponent[], rows: readonly Record<string, unknown>[]): ExportMatrix;
 
 declare class DataGridHeaderComponent implements OnInit, OnDestroy {
     filterControl: FormControl<string>;
@@ -62,6 +69,7 @@ declare class DataGridHeaderComponent implements OnInit, OnDestroy {
     readonly showAddButton: _angular_core.InputSignal<boolean>;
     readonly showRefreshButton: _angular_core.InputSignal<boolean>;
     readonly showExportButton: _angular_core.InputSignal<boolean>;
+    readonly exportFormats: _angular_core.InputSignal<readonly GridExportFormat[]>;
     readonly addButtonLabel: _angular_core.InputSignal<string>;
     readonly searchPlaceholder: _angular_core.InputSignal<string>;
     readonly disableAddButton: _angular_core.InputSignal<boolean>;
@@ -76,7 +84,7 @@ declare class DataGridHeaderComponent implements OnInit, OnDestroy {
     clearSearchValue(): void;
     onAddButtonClick(): void;
     static ɵfac: _angular_core.ɵɵFactoryDeclaration<DataGridHeaderComponent, never>;
-    static ɵcmp: _angular_core.ɵɵComponentDeclaration<DataGridHeaderComponent, "cauca-data-grid-header", never, { "showAddButton": { "alias": "showAddButton"; "required": false; "isSignal": true; }; "showRefreshButton": { "alias": "showRefreshButton"; "required": false; "isSignal": true; }; "showExportButton": { "alias": "showExportButton"; "required": false; "isSignal": true; }; "addButtonLabel": { "alias": "addButtonLabel"; "required": false; "isSignal": true; }; "searchPlaceholder": { "alias": "searchPlaceholder"; "required": false; "isSignal": true; }; "disableAddButton": { "alias": "disableAddButton"; "required": false; "isSignal": true; }; }, { "filterChange": "filterChange"; "addButtonClick": "addButtonClick"; "refreshRequest": "refreshRequest"; "exportRequest": "exportRequest"; }, never, ["[filterRow]"], true, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<DataGridHeaderComponent, "cauca-data-grid-header", never, { "showAddButton": { "alias": "showAddButton"; "required": false; "isSignal": true; }; "showRefreshButton": { "alias": "showRefreshButton"; "required": false; "isSignal": true; }; "showExportButton": { "alias": "showExportButton"; "required": false; "isSignal": true; }; "exportFormats": { "alias": "exportFormats"; "required": false; "isSignal": true; }; "addButtonLabel": { "alias": "addButtonLabel"; "required": false; "isSignal": true; }; "searchPlaceholder": { "alias": "searchPlaceholder"; "required": false; "isSignal": true; }; "disableAddButton": { "alias": "disableAddButton"; "required": false; "isSignal": true; }; }, { "filterChange": "filterChange"; "addButtonClick": "addButtonClick"; "refreshRequest": "refreshRequest"; "exportRequest": "exportRequest"; }, never, ["[filterRow]"], true, never>;
 }
 
 declare enum Density {
@@ -120,6 +128,8 @@ declare abstract class BaseDataGridComponent implements AfterContentInit {
     readonly allowExport: _angular_core.InputSignal<boolean>;
     readonly exportFileName: _angular_core.InputSignal<string>;
     readonly exportRows: _angular_core.InputSignal<() => Promise<unknown[]>>;
+    readonly exportFormats: _angular_core.InputSignal<readonly GridExportFormat[]>;
+    readonly canExport: _angular_core.Signal<boolean>;
     readonly addButtonClick: _angular_core.OutputEmitterRef<void>;
     expandedElement: _angular_core.WritableSignal<any>;
     header: DataGridHeaderComponent;
@@ -149,7 +159,8 @@ declare abstract class BaseDataGridComponent implements AfterContentInit {
     renderRows(): void;
     onDensityChanged(density: Density): void;
     abstract getData(): unknown[];
-    protected abstract getExportSourceRows(): unknown[];
+    /** The rows to export when the caller supplies no `exportRows` provider; may be fetched. */
+    protected abstract getExportSourceRows(): unknown[] | Promise<unknown[]>;
     protected abstract setUpFilterPredicate(): void;
     protected abstract setUpSort(sort: MatSort): void;
     protected abstract forceReloadFilter(): void;
@@ -161,7 +172,7 @@ declare abstract class BaseDataGridComponent implements AfterContentInit {
     protected applyColumns(): void;
     private removeMandatoryColumns;
     static ɵfac: _angular_core.ɵɵFactoryDeclaration<BaseDataGridComponent, never>;
-    static ɵcmp: _angular_core.ɵɵComponentDeclaration<BaseDataGridComponent, "ng-component", never, { "resourceName": { "alias": "resourceName"; "required": true; "isSignal": true; }; "displayedColumns": { "alias": "displayedColumns"; "required": false; "isSignal": true; }; "showAddButton": { "alias": "showAddButton"; "required": false; "isSignal": true; }; "disableAddButton": { "alias": "disableAddButton"; "required": false; "isSignal": true; }; "addButtonLabel": { "alias": "addButtonLabel"; "required": false; "isSignal": true; }; "searchPlaceholder": { "alias": "searchPlaceholder"; "required": false; "isSignal": true; }; "searchableColumns": { "alias": "searchableColumns"; "required": false; "isSignal": true; }; "showTableOptions": { "alias": "showTableOptions"; "required": false; "isSignal": true; }; "showColumnViewer": { "alias": "showColumnViewer"; "required": false; "isSignal": true; }; "showPaginator": { "alias": "showPaginator"; "required": false; "isSignal": true; }; "hidePageSize": { "alias": "hidePageSize"; "required": false; "isSignal": true; }; "showExpandButton": { "alias": "showExpandButton"; "required": false; "isSignal": true; }; "allowExport": { "alias": "allowExport"; "required": false; "isSignal": true; }; "exportFileName": { "alias": "exportFileName"; "required": false; "isSignal": true; }; "exportRows": { "alias": "exportRows"; "required": false; "isSignal": true; }; }, { "addButtonClick": "addButtonClick"; }, ["headerRowDef", "footerRowDef", "noDataRow", "regularColumns", "columnDefs", "rowDefs"], never, true, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<BaseDataGridComponent, "ng-component", never, { "resourceName": { "alias": "resourceName"; "required": true; "isSignal": true; }; "displayedColumns": { "alias": "displayedColumns"; "required": false; "isSignal": true; }; "showAddButton": { "alias": "showAddButton"; "required": false; "isSignal": true; }; "disableAddButton": { "alias": "disableAddButton"; "required": false; "isSignal": true; }; "addButtonLabel": { "alias": "addButtonLabel"; "required": false; "isSignal": true; }; "searchPlaceholder": { "alias": "searchPlaceholder"; "required": false; "isSignal": true; }; "searchableColumns": { "alias": "searchableColumns"; "required": false; "isSignal": true; }; "showTableOptions": { "alias": "showTableOptions"; "required": false; "isSignal": true; }; "showColumnViewer": { "alias": "showColumnViewer"; "required": false; "isSignal": true; }; "showPaginator": { "alias": "showPaginator"; "required": false; "isSignal": true; }; "hidePageSize": { "alias": "hidePageSize"; "required": false; "isSignal": true; }; "showExpandButton": { "alias": "showExpandButton"; "required": false; "isSignal": true; }; "allowExport": { "alias": "allowExport"; "required": false; "isSignal": true; }; "exportFileName": { "alias": "exportFileName"; "required": false; "isSignal": true; }; "exportRows": { "alias": "exportRows"; "required": false; "isSignal": true; }; "exportFormats": { "alias": "exportFormats"; "required": false; "isSignal": true; }; }, { "addButtonClick": "addButtonClick"; }, ["headerRowDef", "footerRowDef", "noDataRow", "regularColumns", "columnDefs", "rowDefs"], never, true, never>;
 }
 
 declare class DataGridComponent extends BaseDataGridComponent implements AfterContentInit, AfterViewInit {
@@ -239,11 +250,14 @@ declare class OdataListingService<T = any> {
     get data(): T[] | null;
     constructor(httpClient: HttpClient);
     initialize({ baseUrl, resourceName, paginator, sort, initialSort, filters }: Props): ODataDataSource;
+    fetchAllForExport(maxRows: number): Observable<T[]>;
     updateFilters(filters: ODataFilter[]): void;
     forceReloadFilter(): void;
     isInitialized(): boolean;
     refresh(): void;
     destroy(): void;
+    /** Mirrors how ODataDataSource reads the active sort, single or multi. */
+    private sortedBy;
     static ɵfac: _angular_core.ɵɵFactoryDeclaration<OdataListingService<any>, never>;
     static ɵprov: _angular_core.ɵɵInjectableDeclaration<OdataListingService<any>>;
 }
@@ -261,6 +275,7 @@ declare class OdataGridComponent extends BaseDataGridComponent implements OnDest
     readonly selectedRowId: _angular_core.InputSignal<any>;
     readonly idField: _angular_core.InputSignal<string>;
     readonly showRefreshButton: _angular_core.InputSignal<boolean>;
+    readonly maxExportRows: _angular_core.InputSignal<number>;
     readonly itemClick: EventEmitter<any>;
     readonly refreshRequested: _angular_core.OutputEmitterRef<void>;
     rowDetailTemplate: TemplateRef<any>;
@@ -282,7 +297,7 @@ declare class OdataGridComponent extends BaseDataGridComponent implements OnDest
     refreshFilter(): void;
     setUpFilterPredicate(): void;
     setUpSort(sort: MatSort): void;
-    protected getExportSourceRows(): unknown[];
+    protected getExportSourceRows(): Promise<unknown[]>;
     protected forceReloadFilter(): void;
     protected computeDisplayedColumns(): string[];
     protected onColumnsChanged(columns: string[]): void;
@@ -299,7 +314,7 @@ declare class OdataGridComponent extends BaseDataGridComponent implements OnDest
     private applyUrlStateToGrid;
     private hasRestoredState;
     static ɵfac: _angular_core.ɵɵFactoryDeclaration<OdataGridComponent, never>;
-    static ɵcmp: _angular_core.ɵɵComponentDeclaration<OdataGridComponent, "cauca-odata-grid", never, { "showTableHeader": { "alias": "showTableHeader"; "required": false; "isSignal": true; }; "persistState": { "alias": "persistState"; "required": false; "isSignal": true; }; "stateKey": { "alias": "stateKey"; "required": false; "isSignal": true; }; "baseSort": { "alias": "baseSort"; "required": false; "isSignal": true; }; "filterPredicate": { "alias": "filterPredicate"; "required": false; "isSignal": true; }; "showHeader": { "alias": "showHeader"; "required": false; "isSignal": true; }; "selectedRowId": { "alias": "selectedRowId"; "required": false; "isSignal": true; }; "idField": { "alias": "idField"; "required": false; "isSignal": true; }; "showRefreshButton": { "alias": "showRefreshButton"; "required": false; "isSignal": true; }; }, { "itemClick": "itemClick"; "refreshRequested": "refreshRequested"; }, ["rowDetailTemplate"], ["[filterRow]", "[customHeader]", "[customFilter]", "*"], true, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<OdataGridComponent, "cauca-odata-grid", never, { "showTableHeader": { "alias": "showTableHeader"; "required": false; "isSignal": true; }; "persistState": { "alias": "persistState"; "required": false; "isSignal": true; }; "stateKey": { "alias": "stateKey"; "required": false; "isSignal": true; }; "baseSort": { "alias": "baseSort"; "required": false; "isSignal": true; }; "filterPredicate": { "alias": "filterPredicate"; "required": false; "isSignal": true; }; "showHeader": { "alias": "showHeader"; "required": false; "isSignal": true; }; "selectedRowId": { "alias": "selectedRowId"; "required": false; "isSignal": true; }; "idField": { "alias": "idField"; "required": false; "isSignal": true; }; "showRefreshButton": { "alias": "showRefreshButton"; "required": false; "isSignal": true; }; "maxExportRows": { "alias": "maxExportRows"; "required": false; "isSignal": true; }; }, { "itemClick": "itemClick"; "refreshRequested": "refreshRequested"; }, ["rowDetailTemplate"], ["[filterRow]", "[customHeader]", "[customFilter]", "*"], true, never>;
 }
 
 interface GridUrlState {
@@ -346,17 +361,11 @@ declare class GridStateRestorationService {
  */
 declare function provideGridStateRestoration(): EnvironmentProviders;
 
-interface ExportMatrix {
-    headers: string[];
-    rows: ExportCell[][];
-}
-declare const GRID_OWNED_COLUMNS: readonly string[];
-declare function buildExportMatrix(columnOrder: readonly string[], columns: readonly BaseGridColumnComponent[], rows: readonly Record<string, unknown>[]): ExportMatrix;
-
 declare class GridExportService {
     private readonly locale;
     toExcel(matrix: ExportMatrix, fileName: string): Promise<void>;
     toPdf(matrix: ExportMatrix, fileName: string): Promise<void>;
+    private load;
     private stringify;
     private download;
     static ɵfac: _angular_core.ɵɵFactoryDeclaration<GridExportService, never>;
@@ -518,5 +527,5 @@ interface CaucaGridOptions {
 declare const PREFERENCE_SERVICE_TOKEN: InjectionToken<BasePreferenceService>;
 declare function provideCaucaGrid(options?: CaucaGridOptions): (Provider | EnvironmentProviders);
 
-export { BaseGridColumnComponent, ColorDataGridColumnComponent, DataGridCheckColumnComponent, DataGridColumnComponent, DataGridCommandIconColumnComponent, DataGridCommandsColumnComponent, DataGridComponent, DataGridHeaderComponent, DataGridIconColumnComponent, DataGridMenuColumnComponent, DataGridRowDropEvent, DateGridColumnComponent, Density, GRID_OWNED_COLUMNS, GridConfiguration, GridExportService, GridStateRestorationService, OdataGridComponent, OdataListingService, PREFERENCE_SERVICE_TOKEN, Preference, SortableDataGridCheckColumnComponent, SortableDataGridColumnComponent, TimeSpanDataGridColumnComponent, TranslationGridColumnComponent, buildExportMatrix, emptyQueryParams, fromQueryParams, paramsEqual, provideCaucaGrid, provideGridStateRestoration, toQueryParams };
-export type { BasePreferenceService, CaucaGridOptions, ExportCell, ExportMatrix, GridUrlState, Paginator, Sort };
+export { ALL_EXPORT_FORMATS, BaseGridColumnComponent, ColorDataGridColumnComponent, DataGridCheckColumnComponent, DataGridColumnComponent, DataGridCommandIconColumnComponent, DataGridCommandsColumnComponent, DataGridComponent, DataGridHeaderComponent, DataGridIconColumnComponent, DataGridMenuColumnComponent, DataGridRowDropEvent, DateGridColumnComponent, Density, GRID_OWNED_COLUMNS, GridConfiguration, GridExportService, GridStateRestorationService, OdataGridComponent, OdataListingService, PREFERENCE_SERVICE_TOKEN, Preference, SortableDataGridCheckColumnComponent, SortableDataGridColumnComponent, TimeSpanDataGridColumnComponent, TranslationGridColumnComponent, buildExportMatrix, emptyQueryParams, fromQueryParams, paramsEqual, provideCaucaGrid, provideGridStateRestoration, toQueryParams };
+export type { BasePreferenceService, CaucaGridOptions, ExportCell, ExportMatrix, GridExportFormat, GridUrlState, Paginator, Sort };