@meshmakers/shared-ui 3.4.640 → 3.4.660

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@meshmakers/shared-ui",
-  "version": "3.4.640",
+  "version": "3.4.660",
   "peerDependencies": {
     "@angular/common": "^22.0.0",
     "@angular/core": "^22.0.0",

package/types/meshmakers-shared-ui.d.ts

@@ -9,11 +9,11 @@ import { Observable } from 'rxjs';
 import { DialogContentBase, DialogRef, WindowRef } from '@progress/kendo-angular-dialog';
 import * as _meshmakers_shared_ui from '@meshmakers/shared-ui';
 import { State } from '@progress/kendo-data-query/dist/npm/state';
-import { PagerSettings, SelectableSettings, SelectionEvent, PageChangeEvent, CellClickEvent, DataBindingDirective } from '@progress/kendo-angular-grid';
+import { PagerSettings, SelectableSettings, SelectionEvent, PageChangeEvent, CellClickEvent, DataBindingDirective, DataStateChangeEvent } from '@progress/kendo-angular-grid';
 import { SVGIcon as SVGIcon$1 } from '@progress/kendo-svg-icons/dist/svg-icon.interface';
 import { MenuItem, ContextMenuComponent, ContextMenuSelectEvent, ContextMenuPopupEvent } from '@progress/kendo-angular-menu';
 import { AutoCompleteComponent } from '@progress/kendo-angular-dropdowns';
-import { CompositeFilterDescriptor } from '@progress/kendo-data-query';
+import { CompositeFilterDescriptor, SortDescriptor, State as State$1 } from '@progress/kendo-data-query';
 import { CanDeactivate } from '@angular/router';
 
 /**
@@ -205,6 +205,8 @@ interface ListViewMessages {
     exportToPdf: string;
     /** Tooltip for "Refresh Data" button. Default: "Refresh Data" */
     refreshData: string;
+    /** Tooltip for the "Reset Filters" button. Default: "Reset Filters" */
+    resetFilters: string;
     /** Title for the actions command column. Default: "Actions" */
     actionsColumnTitle: string;
     /** PDF footer page template. Default: "Page {pageNum} of {totalPages}" */
@@ -307,6 +309,25 @@ declare class ListViewComponent extends CommandBaseService implements OnDestroy,
     sortable: boolean;
     rowFilterEnabled: boolean;
     searchTextBoxEnabled: boolean;
+    /**
+     * Persist the user's sort/row-filter/page across visits (localStorage) so they
+     * are not re-applied every time. On by default. Set `false` to opt a list out
+     * (e.g. a transient/embedded list where a remembered filter would confuse).
+     */
+    persistListState: boolean;
+    /**
+     * Storage key for {@link persistListState}. Defaults to the current route path
+     * (without query string), which is stable per list page. Set an explicit key
+     * when two lists share a route, or to keep the stored state stable across a
+     * route rename.
+     */
+    listStateKey?: string;
+    private readonly routerRef;
+    /**
+     * Resolves the effective storage key for this list, or `null` when
+     * persistence is disabled. Used by {@link MmListViewDataBindingDirective}.
+     */
+    resolveListStateKey(): string | null;
     /** The page size the grid actually uses: the measured fit-to-height value in `autoPageSize` mode, `pageSize` otherwise. */
     protected effectivePageSize(): number;
     private _cachedAutoPageable?;
@@ -420,13 +441,29 @@ declare class ListViewComponent extends CommandBaseService implements OnDestroy,
     protected onRangeFilterChange(value: number | null, column: TableColumn, operator: 'gte' | 'lte'): void;
     protected onShowRowFilter(): void;
     protected onRefresh(): void;
+    /**
+     * Resets all filtering back to the default view: clears the row filter,
+     * column sort, free-text search and page offset, drops the persisted state,
+     * and emits {@link onResetFilters} so the host can also reset its own
+     * quick-view/bar filters.
+     */
+    protected onReset(): void;
     onExecuteFilter: EventEmitter<string | null>;
     onRefreshData: EventEmitter<void>;
+    /** Emitted when the toolbar "Reset Filters" button is clicked (host resets its bar filters). */
+    resetFilters: EventEmitter<void>;
     protected onFilter(value: string | null): Promise<void>;
+    /**
+     * Restores the search box's displayed text without re-triggering a fetch
+     * (used by {@link MmListViewDataBindingDirective} when replaying a persisted
+     * list state — the directive already carries the value into the initial fetch).
+     */
+    restoreSearchValue(value: string | null): void;
     protected readonly filterIcon: SVGIcon$1;
     protected readonly pdfSVG: SVGIcon$1;
     protected readonly excelSVG: SVGIcon$1;
     protected readonly refreshIcon: SVGIcon$1;
+    protected readonly resetFilterIcon: SVGIcon$1;
     protected onRowSelect(event: SelectionEvent): void;
     protected onPageChange(_event: PageChangeEvent): void;
     protected onContextMenuSelect(_event: ContextMenuSelectEvent): Promise<void>;
@@ -443,7 +480,7 @@ declare class ListViewComponent extends CommandBaseService implements OnDestroy,
     protected getPdfPageText(pageNum: number, totalPages: number): string;
     protected readonly moreVerticalIcon: SVGIcon$1;
     static ɵfac: i0.ɵɵFactoryDeclaration<ListViewComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<ListViewComponent, "mm-list-view", never, { "pageSize": { "alias": "pageSize"; "required": false; }; "skip": { "alias": "skip"; "required": false; }; "autoPageSize": { "alias": "autoPageSize"; "required": false; }; "rowIsClickable": { "alias": "rowIsClickable"; "required": false; }; "showRowCheckBoxes": { "alias": "showRowCheckBoxes"; "required": false; }; "showRowSelectAllCheckBox": { "alias": "showRowSelectAllCheckBox"; "required": false; }; "contextMenuType": { "alias": "contextMenuType"; "required": false; }; "leftToolbarActions": { "alias": "leftToolbarActions"; "required": false; }; "rightToolbarActions": { "alias": "rightToolbarActions"; "required": false; }; "actionCommandItems": { "alias": "actionCommandItems"; "required": false; }; "contextMenuCommandItems": { "alias": "contextMenuCommandItems"; "required": false; }; "excelExportFileName": { "alias": "excelExportFileName"; "required": false; }; "pdfExportFileName": { "alias": "pdfExportFileName"; "required": false; }; "pageable": { "alias": "pageable"; "required": false; }; "sortable": { "alias": "sortable"; "required": false; }; "rowFilterEnabled": { "alias": "rowFilterEnabled"; "required": false; }; "searchTextBoxEnabled": { "alias": "searchTextBoxEnabled"; "required": false; }; "resizable": { "alias": "resizable"; "required": false; }; "actionsColumnWidth": { "alias": "actionsColumnWidth"; "required": false; }; "hideCheckboxesBelow": { "alias": "hideCheckboxesBelow"; "required": false; }; "rowClass": { "alias": "rowClass"; "required": false; }; "messages": { "alias": "messages"; "required": false; }; "selectable": { "alias": "selectable"; "required": false; }; "columns": { "alias": "columns"; "required": false; }; }, { "rowClicked": "rowClicked"; }, never, never, true, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<ListViewComponent, "mm-list-view", never, { "pageSize": { "alias": "pageSize"; "required": false; }; "skip": { "alias": "skip"; "required": false; }; "autoPageSize": { "alias": "autoPageSize"; "required": false; }; "rowIsClickable": { "alias": "rowIsClickable"; "required": false; }; "showRowCheckBoxes": { "alias": "showRowCheckBoxes"; "required": false; }; "showRowSelectAllCheckBox": { "alias": "showRowSelectAllCheckBox"; "required": false; }; "contextMenuType": { "alias": "contextMenuType"; "required": false; }; "leftToolbarActions": { "alias": "leftToolbarActions"; "required": false; }; "rightToolbarActions": { "alias": "rightToolbarActions"; "required": false; }; "actionCommandItems": { "alias": "actionCommandItems"; "required": false; }; "contextMenuCommandItems": { "alias": "contextMenuCommandItems"; "required": false; }; "excelExportFileName": { "alias": "excelExportFileName"; "required": false; }; "pdfExportFileName": { "alias": "pdfExportFileName"; "required": false; }; "pageable": { "alias": "pageable"; "required": false; }; "sortable": { "alias": "sortable"; "required": false; }; "rowFilterEnabled": { "alias": "rowFilterEnabled"; "required": false; }; "searchTextBoxEnabled": { "alias": "searchTextBoxEnabled"; "required": false; }; "persistListState": { "alias": "persistListState"; "required": false; }; "listStateKey": { "alias": "listStateKey"; "required": false; }; "resizable": { "alias": "resizable"; "required": false; }; "actionsColumnWidth": { "alias": "actionsColumnWidth"; "required": false; }; "hideCheckboxesBelow": { "alias": "hideCheckboxesBelow"; "required": false; }; "rowClass": { "alias": "rowClass"; "required": false; }; "messages": { "alias": "messages"; "required": false; }; "selectable": { "alias": "selectable"; "required": false; }; "columns": { "alias": "columns"; "required": false; }; }, { "rowClicked": "rowClicked"; "resetFilters": "resetFilters"; }, never, never, true, never>;
 }
 
 declare class UploadFileDialogComponent extends DialogContentBase {
@@ -1042,6 +1079,7 @@ declare abstract class HierarchyDataSourceBase<TQueryDto> extends HierarchyDataS
 
 declare class MmListViewDataBindingDirective extends DataBindingDirective implements OnInit, OnDestroy {
     private readonly dataSource;
+    private readonly listStateService;
     /** Observable indicating if the data source is currently loading data */
     get isLoading$(): Observable<boolean>;
     /** Current loading state */
@@ -1069,6 +1107,30 @@ declare class MmListViewDataBindingDirective extends DataBindingDirective implem
      * new page grid so the pager stays on a valid page, then the data is refetched.
      */
     applyPageSize(take: number): void;
+    /**
+     * Kendo emits this for header-sort clicks, the built-in filter row and the
+     * pager. Persist the resulting state so those interactions survive a revisit.
+     */
+    onStateChange(state: DataStateChangeEvent): void;
+    /** Effective per-list storage key, or null when persistence is disabled/unavailable. */
+    private stateKey;
+    /**
+     * Restores the persisted sort/filter/page into the grid state via the
+     * inherited setters (which sync both the Kendo grid and the query state).
+     * `take`/`pageSize` is intentionally not restored — it is the caller's
+     * initial pageSize or the autoPageSize measurement.
+     */
+    private restoreState;
+    /**
+     * Clears all filtering for this list back to the default view: row filter,
+     * column sort, free-text search and page offset, and drops the persisted
+     * entry (incl. any app-owned bar filters) so nothing is restored next visit.
+     * The app-side bar filters are reset by the host via
+     * {@link ListViewComponent.onResetFilters}.
+     */
+    resetState(): void;
+    /** Writes the current sort/filter/skip + free-text search for this list to storage (best-effort). */
+    private persistState;
     rebind(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<MmListViewDataBindingDirective, never>;
     static ɵdir: i0.ɵɵDirectiveDeclaration<MmListViewDataBindingDirective, "[mmListViewDataBinding]", never, {}, {}, never, never, true, never>;
@@ -1191,6 +1253,63 @@ declare class MessageListenerService implements OnDestroy {
     static ɵprov: i0.ɵɵInjectableDeclaration<MessageListenerService>;
 }
 
+/**
+ * The slice of a Kendo grid {@link State} that is worth persisting for a list
+ * view: the user's sort, row filter and current page offset. `take`/`pageSize`
+ * is deliberately excluded — in `autoPageSize` mode it is re-derived from the
+ * viewport on every load, so persisting it is pointless (and restoring it would
+ * fight the measurement).
+ */
+interface PersistedListState {
+    sort?: SortDescriptor[];
+    filter?: CompositeFilterDescriptor;
+    skip?: number;
+    /** Free-text "search all columns" value — lives outside the Kendo state. */
+    textSearch?: string | null;
+    /**
+     * App-owned extra state stored under the same list key — e.g. the coarse
+     * "quick view" / bar filters (category, view, date range) that live in app
+     * signals rather than the Kendo grid state. Opaque to this service; the host
+     * app defines the shape. Written via {@link ListStateService.saveExtra} and
+     * preserved by the directive's own {@link ListStateService.save}.
+     */
+    extra?: unknown;
+}
+/**
+ * Persists list-view sort/filter/paging per list so users do not have to
+ * re-apply them on every visit. Central to shared-ui so every app gets the
+ * behaviour for free (see {@link ListViewComponent.listStateKey}).
+ *
+ * Storage is a single namespaced blob in localStorage (survives reloads and
+ * browser restarts), keyed by list — mirroring {@link WindowStateService}'s
+ * `mm-window-states` map pattern. Every access is guarded: a corrupt or
+ * unavailable store must never break a list, it just falls back to no state.
+ */
+declare class ListStateService {
+    private readonly storageKey;
+    /** Returns the persisted state for `key`, with date filter values re-hydrated to `Date`. */
+    load(key: string): PersistedListState | null;
+    /**
+     * Stores the sort/filter/skip slice of `state` for `key` plus the free-text
+     * search (which lives outside the Kendo state). `take` is intentionally dropped.
+     */
+    save(key: string, state: State$1, textSearch?: string | null): void;
+    /**
+     * Stores app-owned extra state (e.g. quick-view/bar filters) under `key`,
+     * merging into the same entry as the grid state without clobbering it.
+     */
+    saveExtra(key: string, extra: unknown): void;
+    /** Returns the app-owned extra state stored under `key`, or null. */
+    loadExtra<T>(key: string): T | null;
+    /** Drops the stored state for `key`. */
+    clear(key: string): void;
+    private reviveFilterDates;
+    private loadAll;
+    private saveAll;
+    static ɵfac: i0.ɵɵFactoryDeclaration<ListStateService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<ListStateService>;
+}
+
 interface MessageDetailsDialogMessages {
     copyToClipboard: string;
     close: string;
@@ -2333,5 +2452,5 @@ declare class WindowStateService {
 
 declare function provideMmSharedUi(): EnvironmentProviders;
 
-export { BaseFormComponent, BaseTreeDetailComponent, ButtonTypes, BytesToSizePipe, CRON_PRESETS, ConfirmationService, ConfirmationWindowComponent, ConfirmationWindowResult, CopyableTextComponent, CronBuilderComponent, CronHumanizerService, CronParserService, DEFAULT_CONFIRMATION_WINDOW_MESSAGES, DEFAULT_CRON_BUILDER_CONFIG, DEFAULT_ENTITY_SELECT_DIALOG_MESSAGES, DEFAULT_ENTITY_SELECT_INPUT_MESSAGES, DEFAULT_INPUT_DIALOG_MESSAGES, DEFAULT_LIST_VIEW_MESSAGES, DEFAULT_MESSAGE_DETAILS_DIALOG_MESSAGES, DEFAULT_NOTIFICATION_DISPLAY_MESSAGES, DEFAULT_PROGRESS_WINDOW_MESSAGES, DEFAULT_RESPONSIVE_COLSPAN, DEFAULT_SAVE_AS_DIALOG_MESSAGES, DEFAULT_TIME_RANGE_LABELS, DataSourceBase, DataSourceTyped, DialogType, EntitySelectDialogComponent, EntitySelectDialogService, EntitySelectInputComponent, FetchResultBase, FetchResultTyped, FileUploadResult, FileUploadService, FormTitleExtraDirective, HAS_UNSAVED_CHANGES, HOUR_INTERVALS, HierarchyDataSource, HierarchyDataSourceBase, ImportStrategyDialogComponent, ImportStrategyDialogResult, ImportStrategyDialogService, ImportStrategyDto, InputDialogComponent, InputService, ListViewComponent, MINUTE_INTERVALS, MessageDetailsDialogComponent, MessageDetailsDialogService, MessageListenerService, MmListViewDataBindingDirective, NotificationDisplayService, PascalCasePipe, ProgressValue, ProgressWindowComponent, ProgressWindowService, RELATIVE_WEEKS, SECOND_INTERVALS, SaveAsDialogComponent, SaveAsDialogService, TimeRangePickerComponent, TimeRangeUtils, TreeComponent, UnsavedChangesDirective, UnsavedChangesGuard, UploadFileDialogComponent, WEEKDAYS, WEEKDAY_ABBREVIATIONS, WindowStateService, generateDayOfMonthOptions, generateHourOptions, generateMinuteOptions, provideMmSharedUi };
-export type { BadgeMapping, BadgeMappingTable, BaseFormConfig, BaseFormMessages, ColumnDefinition, ConfirmationButtonLabels, ConfirmationWindowData, ConfirmationWindowMessages, ContextMenuType, CronBuilderConfig, CronFields, CronPreset, CronSchedule, CronValidationResult, DialogFetchOptions, DialogFetchResult, DropdownOption, EntitySelectDialogDataSource, EntitySelectDialogMessages, EntitySelectDialogOptions, EntitySelectDialogResult, EntitySelectInputMessages, FetchDataOptions, FetchResult, FileUploadData, HasUnsavedChanges, InputDialogMessages, ListViewMessages, MessageDetailsDialogData, MessageDetailsDialogMessages, NameAvailabilityResult, NodeDroppedEvent, NodeInfo, NotificationDisplayMessages, ProgressWindowConfig, ProgressWindowData, ProgressWindowMessages, ProgressWindowOptions, ProgressWindowResult, Quarter, RelativeTimeUnit, ResponsiveFormBreakPoint, RowClassFn, SaveAsDialogDataSource, SaveAsDialogMessages, SaveAsDialogOptions, SaveAsDialogResult, ScheduleType, StatusFieldConfig, StatusIconMapping, StatusMapping, TableColumn, TimeRange, TimeRangeISO, TimeRangeOption, TimeRangePickerConfig, TimeRangePickerLabels, TimeRangeSelection, TimeRangeType, TimeRangeZone, UnsavedChangesMessages, Weekday, WindowDimensions };
+export { BaseFormComponent, BaseTreeDetailComponent, ButtonTypes, BytesToSizePipe, CRON_PRESETS, ConfirmationService, ConfirmationWindowComponent, ConfirmationWindowResult, CopyableTextComponent, CronBuilderComponent, CronHumanizerService, CronParserService, DEFAULT_CONFIRMATION_WINDOW_MESSAGES, DEFAULT_CRON_BUILDER_CONFIG, DEFAULT_ENTITY_SELECT_DIALOG_MESSAGES, DEFAULT_ENTITY_SELECT_INPUT_MESSAGES, DEFAULT_INPUT_DIALOG_MESSAGES, DEFAULT_LIST_VIEW_MESSAGES, DEFAULT_MESSAGE_DETAILS_DIALOG_MESSAGES, DEFAULT_NOTIFICATION_DISPLAY_MESSAGES, DEFAULT_PROGRESS_WINDOW_MESSAGES, DEFAULT_RESPONSIVE_COLSPAN, DEFAULT_SAVE_AS_DIALOG_MESSAGES, DEFAULT_TIME_RANGE_LABELS, DataSourceBase, DataSourceTyped, DialogType, EntitySelectDialogComponent, EntitySelectDialogService, EntitySelectInputComponent, FetchResultBase, FetchResultTyped, FileUploadResult, FileUploadService, FormTitleExtraDirective, HAS_UNSAVED_CHANGES, HOUR_INTERVALS, HierarchyDataSource, HierarchyDataSourceBase, ImportStrategyDialogComponent, ImportStrategyDialogResult, ImportStrategyDialogService, ImportStrategyDto, InputDialogComponent, InputService, ListStateService, ListViewComponent, MINUTE_INTERVALS, MessageDetailsDialogComponent, MessageDetailsDialogService, MessageListenerService, MmListViewDataBindingDirective, NotificationDisplayService, PascalCasePipe, ProgressValue, ProgressWindowComponent, ProgressWindowService, RELATIVE_WEEKS, SECOND_INTERVALS, SaveAsDialogComponent, SaveAsDialogService, TimeRangePickerComponent, TimeRangeUtils, TreeComponent, UnsavedChangesDirective, UnsavedChangesGuard, UploadFileDialogComponent, WEEKDAYS, WEEKDAY_ABBREVIATIONS, WindowStateService, generateDayOfMonthOptions, generateHourOptions, generateMinuteOptions, provideMmSharedUi };
+export type { BadgeMapping, BadgeMappingTable, BaseFormConfig, BaseFormMessages, ColumnDefinition, ConfirmationButtonLabels, ConfirmationWindowData, ConfirmationWindowMessages, ContextMenuType, CronBuilderConfig, CronFields, CronPreset, CronSchedule, CronValidationResult, DialogFetchOptions, DialogFetchResult, DropdownOption, EntitySelectDialogDataSource, EntitySelectDialogMessages, EntitySelectDialogOptions, EntitySelectDialogResult, EntitySelectInputMessages, FetchDataOptions, FetchResult, FileUploadData, HasUnsavedChanges, InputDialogMessages, ListViewMessages, MessageDetailsDialogData, MessageDetailsDialogMessages, NameAvailabilityResult, NodeDroppedEvent, NodeInfo, NotificationDisplayMessages, PersistedListState, ProgressWindowConfig, ProgressWindowData, ProgressWindowMessages, ProgressWindowOptions, ProgressWindowResult, Quarter, RelativeTimeUnit, ResponsiveFormBreakPoint, RowClassFn, SaveAsDialogDataSource, SaveAsDialogMessages, SaveAsDialogOptions, SaveAsDialogResult, ScheduleType, StatusFieldConfig, StatusIconMapping, StatusMapping, TableColumn, TimeRange, TimeRangeISO, TimeRangeOption, TimeRangePickerConfig, TimeRangePickerLabels, TimeRangeSelection, TimeRangeType, TimeRangeZone, UnsavedChangesMessages, Weekday, WindowDimensions };