@arsedizioni/ars-utils 22.5.47 → 22.5.49

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arsedizioni/ars-utils",
-  "version": "22.5.47",
+  "version": "22.5.49",
   "author": {
     "email": "software@arsedizioni.it",
     "name": "Fabio Buscaroli, Alberto Doria"

package/types/arsedizioni-ars-utils-ui.d.ts

@@ -1,4 +1,4 @@
-import { Searchable, INode, DateInterval, SearchBag, NameValueItem } from '@arsedizioni/ars-utils/core';
+import { Searchable, INode, SearchBag, DateInterval, NameValueItem } from '@arsedizioni/ars-utils/core';
 import { MatFormFieldAppearance } from '@angular/material/form-field';
 import * as _angular_core from '@angular/core';
 import { TemplateRef, InjectionToken, Signal, ElementRef, Renderer2 } from '@angular/core';
@@ -111,6 +111,35 @@ interface SelectDialogData {
     searchLabel?: string;
     searchButtonLabel?: string;
 }
+/**
+ * Data of `ListDialogComponent`: the read-only sibling of {@link SelectDialogData}.
+ *
+ * It carries no `can*` flag on purpose — the dialog shows a searchable list and closes, so there
+ * is nothing to enable — and no `mustSelect` / `okCaption` either, because there is no
+ * confirmation step to gate.
+ */
+interface ListDialogData {
+    /** Dialog title, rendered as HTML. */
+    title: string;
+    /** Optional description shown under the title, rendered as HTML. */
+    description?: string;
+    /** Optional header shown above the list, rendered as HTML. Hidden while the list is empty. */
+    header?: string;
+    /** Items to display. */
+    items?: SelectableItem[];
+    /** Initial search text. */
+    filter?: string;
+    /** Message shown in place of the list when there is nothing to display. Rendered as HTML. */
+    emptyMessage?: string;
+    /** Caption of the close button, which is always available. Defaults to `Chiudi`. */
+    closeCaption?: string;
+    /** Label of the search field. Defaults to `Cerca...`. */
+    searchLabel?: string;
+    /** Appearance of the search field. Defaults to `outline`. */
+    appearance?: MatFormFieldAppearance;
+    /** Preferred dialog width, in pixels, for the caller that opens it. */
+    width?: number;
+}
 interface SelectTreeDialogData {
     title: string;
     description?: string;
@@ -910,4 +939,4 @@ declare class FlexLayoutModule {
 }
 
 export { ALIAS_FAMILIES, BS5_BREAKPOINTS, CANONICAL_ALIASES, FlexLayoutModule, FxClassDirective, FxFlexAlignDirective, FxFlexDirective, FxFlexFillDirective, FxFlexOffsetDirective, FxFlexOrderDirective, FxGridAreaDirective, FxGridColumnDirective, FxGridDirective, FxLayoutAlignDirective, FxLayoutDirective, FxLayoutGapDirective, FxLayoutWrapDirective, FxShowHideDirective, FxStyleDirective, IfBpDirective, ItemNode, LAYOUT_BREAKPOINTS, LAYOUT_VALUES, MediaObserver, NON_CANONICAL_PRIORITY, PromptDialogType, ResponsiveBaseDirective, SelectableItem, SelectableNode, UIService, applyVisibility, buildAlignStyles, buildFlexStyles, buildLayoutCSS, resolve, resolveAll, resolveFlexInput, resolveNonCanonical, resolveParentFlow, validateBasis, validateLayoutValue, validateWrapValue };
-export type { BpValues, BreakpointAlias, CanonicalKey, CredentialsDialogResult, DialogOption, DialogResult, ISelectableItem, ISendToDialog, NcValues, NonCanonicalKey, PromptDateDialogResult, PromptDialogData, PromptDialogResult, PromptOtpDialogResult, PromptTimeDialogData, RecoverPasswordDialogResult, ResetPasswordDialogResult, SelectDialogAppend, SelectDialogData, SelectDialogDelete, SelectDialogEdit, SelectDialogFilter, SelectDialogLookup, SelectDialogResult, SelectFile, SelectFileDialogData, SelectFileOption, SelectPictureFileDialogData, SelectTreeDialogData, SelectTreeDialogResult, SelectableFilter, SendToDialogResult, SendToPopulateData };
+export type { BpValues, BreakpointAlias, CanonicalKey, CredentialsDialogResult, DialogOption, DialogResult, ISelectableItem, ISendToDialog, ListDialogData, NcValues, NonCanonicalKey, PromptDateDialogResult, PromptDialogData, PromptDialogResult, PromptOtpDialogResult, PromptTimeDialogData, RecoverPasswordDialogResult, ResetPasswordDialogResult, SelectDialogAppend, SelectDialogData, SelectDialogDelete, SelectDialogEdit, SelectDialogFilter, SelectDialogLookup, SelectDialogResult, SelectFile, SelectFileDialogData, SelectFileOption, SelectPictureFileDialogData, SelectTreeDialogData, SelectTreeDialogResult, SelectableFilter, SendToDialogResult, SendToPopulateData };

package/types/arsedizioni-ars-utils-ui.dialogs.auth.d.ts

@@ -122,6 +122,7 @@ interface CredentialsDialogData {
     user?: string;
     okCaption?: string;
     mode?: 'email' | 'user' | 'otp';
+    maxLength?: number;
     appearance?: MatFormFieldAppearance;
 }
 /**
@@ -197,6 +198,7 @@ declare class CredentialsDialogComponent {
 type ResetPasswordDialogMode = 'admin' | 'old' | 'otp' | 'forgot';
 interface ResetPasswordDialogData {
     mode: ResetPasswordDialogMode;
+    maxLength?: number;
     userId?: number;
     userEmail?: string;
     appearance?: MatFormFieldAppearance;

package/types/arsedizioni-ars-utils-ui.dialogs.select.d.ts

@@ -1,16 +1,62 @@
 import * as _angular_forms_signals from '@angular/forms/signals';
 import * as _angular_core from '@angular/core';
 import { OnDestroy } from '@angular/core';
+import { SearchFilterMetadata } from '@arsedizioni/ars-utils/core';
+import { ListDialogData, SelectableItem, SelectDialogData, SelectDialogResult, SelectDialogEdit, SelectDialogAppend, SelectDialogDelete, SelectDialogLookup, SelectDialogFilter, SelectableFilter, ItemNode, SelectTreeDialogResult, SelectTreeDialogData, ISendToDialog, SendToDialogResult, SendToPopulateData } from '@arsedizioni/ars-utils/ui';
 import { MatCheckboxChange } from '@angular/material/checkbox';
 import { MatSelectionList, MatSelectionListChange } from '@angular/material/list';
 import { MatPaginator, PageEvent } from '@angular/material/paginator';
-import { SearchFilterMetadata } from '@arsedizioni/ars-utils/core';
-import { SelectDialogData, SelectDialogResult, SelectDialogEdit, SelectableItem, SelectDialogAppend, SelectDialogDelete, SelectDialogLookup, SelectDialogFilter, SelectableFilter, ItemNode, SelectTreeDialogResult, SelectTreeDialogData, ISendToDialog, SendToDialogResult, SendToPopulateData } from '@arsedizioni/ars-utils/ui';
 import * as rxjs from 'rxjs';
 import { MatTree } from '@angular/material/tree';
 import { MatFormFieldAppearance } from '@angular/material/form-field';
 import { SignalsUtils } from '@arsedizioni/ars-utils/core.validators';
 
+/**
+ * Read-only counterpart of `SelectDialogComponent`: it shows a list of items with a search box
+ * and nothing else.
+ *
+ * Deliberately not a selection: the list is a plain `mat-list`, not a `mat-selection-list`, so
+ * there is no selected state to read, no `done` payload and no Ok / Annulla pair — closing is the
+ * only way out and it is always available. It carries no add / edit / delete affordance either:
+ * a dialog that cannot change anything is the whole point, and a caller that needs commands wants
+ * `SelectDialogComponent` instead.
+ *
+ * Filtering is client-side, through the same `search` pipe the select dialog uses on its local
+ * items. There is no server-side lookup: paging a list nobody can act on would buy nothing.
+ */
+declare class ListDialogComponent {
+    private readonly cdr;
+    protected readonly dialogData: _angular_core.WritableSignal<ListDialogData>;
+    /** Items currently on screen. Seeded from the dialog data and replaceable through {@link setItems}. */
+    protected readonly items: _angular_core.WritableSignal<SelectableItem[]>;
+    /** Counters written by the `search` pipe while it filters, read back by the footer. */
+    protected filterMetadata: SearchFilterMetadata;
+    /** Current search text. */
+    protected readonly filterText: _angular_core.WritableSignal<string>;
+    /** Root signal form bound to the search input. */
+    protected readonly filterForm: _angular_forms_signals.FieldTree<string, string | number, "writable">;
+    /**
+     * Replaces the items on screen, for a caller that fills the list after opening the dialog or
+     * refreshes it while it is open.
+     * @param items - The new items to display; an empty array clears the list.
+     */
+    setItems(items: SelectableItem[]): void;
+    /**
+     * Sets the search text programmatically.
+     * @param text - The new search string to apply.
+     */
+    setFilter(text: string): void;
+    /**
+     * Returns the current search text.
+     * @returns The active search string.
+     */
+    getFilter(): string;
+    /** Clears the search text, restoring the whole list. */
+    protected clearFilter(): void;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<ListDialogComponent, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<ListDialogComponent, "ng-component", never, {}, {}, never, never, true, never>;
+}
+
 declare class SelectDialogComponent {
     readonly paginator: _angular_core.Signal<MatPaginator>;
     readonly selection: _angular_core.Signal<MatSelectionList>;
@@ -345,5 +391,5 @@ declare class SendToDialogComponent implements ISendToDialog {
     static ɵcmp: _angular_core.ɵɵComponentDeclaration<SendToDialogComponent, "ng-component", never, {}, { "done": "done"; "populate": "populate"; }, never, never, true, never>;
 }
 
-export { SelectDialogComponent, SelectTreeDialogComponent, SendToDialogComponent, TreeDataSource };
+export { ListDialogComponent, SelectDialogComponent, SelectTreeDialogComponent, SendToDialogComponent, TreeDataSource };
 export type { SelectTreeDialogAppend, SendToDialogData };