@cauca-911/datagrid 21.3.0 → 21.3.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cauca-911/datagrid",
-  "version": "21.3.0",
+  "version": "21.3.2",
   "peerDependencies": {
     "@angular/common": ">=21.2.0",
     "@angular/core": ">=21.2.0",

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

@@ -1,5 +1,5 @@
 import * as i0 from '@angular/core';
-import { OnDestroy, OnInit, EventEmitter, AfterContentInit, OnChanges, QueryList, SimpleChanges, AfterViewInit, TemplateRef, ModelSignal, InputSignal, Type, InjectionToken, Provider, EnvironmentProviders } from '@angular/core';
+import { OnDestroy, OnInit, EventEmitter, AfterContentInit, OnChanges, QueryList, SimpleChanges, AfterViewInit, TemplateRef, EnvironmentProviders, ModelSignal, InputSignal, Type, InjectionToken, Provider } from '@angular/core';
 import { MatTable, MatColumnDef, MatCellDef, MatHeaderCellDef, MatFooterCellDef, MatHeaderRowDef, MatFooterRowDef, MatRowDef, MatNoDataRow, MatTableDataSource } from '@angular/material/table';
 import { CdkDragDrop } from '@angular/cdk/drag-drop';
 import { MatPaginator } from '@angular/material/paginator';
@@ -9,6 +9,7 @@ import { MatSort } from '@angular/material/sort';
 import { TranslateService } from '@ngx-translate/core';
 import { ODataDataSource, ODataFilter } from 'odata-data-source';
 import { HttpClient } from '@angular/common/http';
+import { Params, ParamMap } from '@angular/router';
 
 declare class DataGridRowDropEvent {
     item: unknown;
@@ -226,9 +227,13 @@ declare class OdataListingService<T = any> {
     static ɵprov: i0.ɵɵInjectableDeclaration<OdataListingService<any>>;
 }
 
-declare class OdataGridComponent extends BaseDataGridComponent implements OnChanges, OnDestroy {
+declare class OdataGridComponent extends BaseDataGridComponent implements OnChanges, OnDestroy, AfterViewInit {
     readonly listing: OdataListingService;
     showTableHeader: i0.InputSignal<boolean>;
+    /** Master switch: when true, the grid's filter/sort/page are synced with the URL query params and restored when returning from a detail page. Off by default. */
+    persistState: i0.InputSignal<boolean>;
+    /** Optional prefix for the persisted query params, so two independent grids on the same route don't collide (e.g. "alerts" -> "alertsFilter"). */
+    stateKey: i0.InputSignal<string>;
     baseSort?: string[];
     filterPredicate?: (filter: string) => ODataFilter[];
     showHeader: boolean;
@@ -240,8 +245,16 @@ declare class OdataGridComponent extends BaseDataGridComponent implements OnChan
     rowDetailTemplate: TemplateRef<any>;
     paginator: MatPaginator;
     private readonly baseUrl;
+    private readonly router;
+    private readonly route;
+    private readonly destroyRef;
+    private defaultPageSize?;
+    private pendingRestoredFilter?;
+    private lastWrittenParams;
+    private restoredState?;
     constructor(translateService: TranslateService, listing: OdataListingService);
     ngOnDestroy(): void;
+    ngAfterViewInit(): void;
     refreshData(): void;
     ngOnChanges(changes: SimpleChanges): void;
     getData(): unknown[];
@@ -254,9 +267,62 @@ declare class OdataGridComponent extends BaseDataGridComponent implements OnChan
     protected updateDataWhenNeeded(_changes: SimpleChanges): void;
     protected onColumnsChanged(columns: string[]): void;
     protected showColumnsWhenTableOptionsIsFalse(): void;
+    private canPersistState;
+    private restoreStateBeforeInitialLoad;
+    private setUpUrlStatePersistence;
+    private applySortAndPage;
+    private currentUrlState;
+    private writeCurrentUrlState;
+    private reactToExternalUrlStateChange;
+    private applyUrlStateToGrid;
+    private hasRestoredState;
     static ɵfac: i0.ɵɵFactoryDeclaration<OdataGridComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<OdataGridComponent, "cauca-odata-grid", never, { "showTableHeader": { "alias": "showTableHeader"; "required": false; "isSignal": true; }; "baseSort": { "alias": "baseSort"; "required": false; }; "filterPredicate": { "alias": "filterPredicate"; "required": false; }; "showHeader": { "alias": "showHeader"; "required": false; }; "selectedRowId": { "alias": "selectedRowId"; "required": false; }; "idField": { "alias": "idField"; "required": false; }; "showRefreshButton": { "alias": "showRefreshButton"; "required": false; }; }, { "itemClick": "itemClick"; "refreshRequested": "refreshRequested"; }, ["rowDetailTemplate"], ["[filterRow]", "[customHeader]", "[customFilter]", "*"], true, never>;
+    static ɵcmp: i0.ɵɵ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; }; "filterPredicate": { "alias": "filterPredicate"; "required": false; }; "showHeader": { "alias": "showHeader"; "required": false; }; "selectedRowId": { "alias": "selectedRowId"; "required": false; }; "idField": { "alias": "idField"; "required": false; }; "showRefreshButton": { "alias": "showRefreshButton"; "required": false; }; }, { "itemClick": "itemClick"; "refreshRequested": "refreshRequested"; }, ["rowDetailTemplate"], ["[filterRow]", "[customHeader]", "[customFilter]", "*"], true, never>;
+}
+
+interface GridUrlState {
+    filter?: string;
+    sort?: string;
+    direction?: 'asc' | 'desc' | '';
+    pageIndex?: number;
+    pageSize?: number;
 }
+declare function toQueryParams(state: GridUrlState, key?: string): Params;
+declare function fromQueryParams(map: ParamMap, key?: string): GridUrlState;
+/**
+ * Returns a Params object with every grid-state param name mapped to `null` for the given key.
+ * Combined with `queryParamsHandling: 'merge'`, this lets the grid explicitly clear stale
+ * params (e.g. a previously-set filter) instead of leaving them stuck in the URL.
+ */
+declare function emptyQueryParams(key?: string): Params;
+declare function paramsEqual(a: Params, b: Params): boolean;
+
+/**
+ * Re-injects a list page's remembered grid query params (filter/sort/page, written by
+ * `OdataGridComponent` when `persistState` is enabled) when the user navigates back to that
+ * list page from one of its own descendant (detail) routes. Any other way of reaching the
+ * list page (menu, bookmark, direct link, refresh) leaves it clean, because the previous URL
+ * won't be a descendant of the list path.
+ */
+declare class GridStateRestorationService {
+    private readonly router;
+    private readonly rememberedParamsByPath;
+    private previousPath;
+    constructor();
+    private onNavigationEnd;
+    private restoreIfReturningFromDescendant;
+    private pathOnly;
+    private parseParams;
+    static ɵfac: i0.ɵɵFactoryDeclaration<GridStateRestorationService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<GridStateRestorationService>;
+}
+
+/**
+ * Activates the grid list-state restoration feature for the whole application. Add this once
+ * in the app's root providers; it has no effect on pages whose grids don't opt in via
+ * `[persistState]="true"`.
+ */
+declare function provideGridStateRestoration(): EnvironmentProviders;
 
 declare class ColorDataGridColumnComponent extends BaseGridColumnComponent implements OnDestroy, OnInit {
     readonly odata: OdataGridComponent;
@@ -408,5 +474,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, GridConfiguration, OdataGridComponent, OdataListingService, PREFERENCE_SERVICE_TOKEN, Preference, SortableDataGridCheckColumnComponent, SortableDataGridColumnComponent, TimeSpanDataGridColumnComponent, TranslationGridColumnComponent, provideCaucaGrid };
-export type { BasePreferenceService, CaucaGridOptions, Paginator, Sort };
+export { BaseGridColumnComponent, ColorDataGridColumnComponent, DataGridCheckColumnComponent, DataGridColumnComponent, DataGridCommandIconColumnComponent, DataGridCommandsColumnComponent, DataGridComponent, DataGridHeaderComponent, DataGridIconColumnComponent, DataGridMenuColumnComponent, DataGridRowDropEvent, DateGridColumnComponent, Density, GridConfiguration, GridStateRestorationService, OdataGridComponent, OdataListingService, PREFERENCE_SERVICE_TOKEN, Preference, SortableDataGridCheckColumnComponent, SortableDataGridColumnComponent, TimeSpanDataGridColumnComponent, TranslationGridColumnComponent, emptyQueryParams, fromQueryParams, paramsEqual, provideCaucaGrid, provideGridStateRestoration, toQueryParams };
+export type { BasePreferenceService, CaucaGridOptions, GridUrlState, Paginator, Sort };