@messaia/cdk 22.0.1-rc.19 → 22.0.1-rc.21

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@messaia/cdk",
-  "version": "22.0.1-rc.19",
+  "version": "22.0.1-rc.21",
   "peerDependencies": {
     "@angular/common": "^22.0.7",
     "@angular/core": "^22.0.7",

package/types/messaia-cdk.d.ts

@@ -4053,7 +4053,11 @@ declare class Pagination<TModel> {
 }
 
 /**
- * A generic datasource for data-table
+ * @class TableDataSource
+ * @description Provides a server-backed data source with filtering, sorting, pagination,
+ * reloading, and row selection for an Angular Material table.
+ * @template TEntity - The entity type displayed by the table.
+ * @template TService - The service type used to retrieve entities.
  */
 declare class TableDataSource<TEntity, TService extends GenericService<TEntity>> extends DataSource<TEntity> {
     service: TService;
@@ -4061,214 +4065,238 @@ declare class TableDataSource<TEntity, TService extends GenericService<TEntity>>
     sorter?: MatSort | undefined;
     /**
      * @property _filterChange
-     * @description Represents a value that changes over time.
-     * Observers can subscribe to this BehaviorSubject to receive filter changes.
+     * @description Stores and emits the current free-text filter.
      * @type {BehaviorSubject<string>}
      */
     private _filterChange;
     /**
      * @property _reloadChange
-     * @description Represents a value that triggers reload actions.
-     * It is used to notify when a reload should occur by emitting a new value.
+     * @description Emits a new token whenever the table data must be reloaded.
      * @type {BehaviorSubject<number>}
      */
     _reloadChange: BehaviorSubject<number>;
     /**
      * @property onDataLoaded
-     * @description Event emitted after the data is loaded.
-     * It is a BehaviorSubject that holds pagination data or a null value if no data is loaded.
+     * @description Emits the latest pagination response after data loads successfully.
+     * The initial value is `null` until the first response is received.
      * @type {BehaviorSubject<Pagination<TEntity> | any>}
      */
     onDataLoaded: BehaviorSubject<Pagination<TEntity> | any>;
     /**
      * @property selectionModel
-     * @description Used to power selecting one or more options from a list.
+     * @description Tracks the entities selected across the table.
      * @type {SelectionModel<TEntity>}
      */
     selectionModel: SelectionModel<TEntity>;
     /**
      * @property filter
-     * @description Gets the current filter applied to the data.
+     * @description Gets the current free-text filter.
      * @type {string}
      */
     get filter(): string;
     /**
      * @property filter
-     * @description Sets the filter and resets the page index if the paginator exists.
-     * @param {string} filter - The filter value to be applied.
+     * @description Sets the free-text filter and returns pagination to the first page.
+     * @param {string} filter - The filter text to apply.
      */
     set filter(filter: string);
     /**
      * @property onSortChange
-     * @description Sort change event emitter used to notify changes in sorting.
+     * @description Relays changes emitted by the assigned sort controller.
      * @type {EventEmitter<Sort>}
      */
     private onSortChange;
     /**
      * @property _sort
-     * @description Private instance of MatSort used to control the sorting of the table.
-     * @type {MatSort | null}
+     * @description Stores the sort controller currently assigned to the data source.
+     * @type {MatSort | undefined}
      */
     private _sort?;
     /**
      * @property sort
-     * @description Gets or sets the MatSort instance used to control the sorting of the table.
-     * Changes in sorting will trigger an update to the table’s rendered data.
+     * @description Gets or sets the sort controller whose changes reload the table data.
      * @type {MatSort | undefined}
      */
     get sort(): MatSort | undefined;
     set sort(sort: MatSort | undefined);
     /**
      * @property reloadToken
-     * @description Gets the current reload token, used to trigger reload events.
+     * @description Gets the token emitted by the most recent reload request.
      * @type {number}
      */
     get reloadToken(): number;
     /**
      * @property isConnected
-     * @description Flag indicating whether the data source is connected.
+     * @description Indicates whether a collection viewer is connected to the data source.
      * @type {boolean}
      */
     isConnected: boolean;
     /**
      * @property includes
-     * @description The list of navigations to be included in the data query.
+     * @description Lists the related resources to include in each data request.
      * @type {Array<string>}
      */
     includes: Array<string>;
     /**
      * @property path
-     * @description The endpoint path for the data source.
+     * @description Specifies the optional service endpoint path used to retrieve data.
      * @type {string | undefined}
      */
     path?: string;
     /**
      * @property projection
-     * @description Defines the fields to be included in the data query projection.
+     * @description Specifies the fields requested from the service, either as a comma-separated
+     * string or an array of field names.
      * @type {string | string[]}
      */
     projection: string | string[];
     /**
      * @property items
-     * @description The list of items to be displayed in the data table.
+     * @description Contains the entities returned for the current page.
      * @type {TEntity[]}
      */
     items: TEntity[];
     /**
      * @property parameters
-     * @description The parameters for pagination and sorting.
+     * @description Contains additional parameters returned by the latest data request.
      * @type {any}
      */
     parameters?: any;
     /**
      * @property facets
-     * @description The list of facets for filtering items.
+     * @description Contains the facets returned by the latest data request.
      * @type {Facet[] | undefined}
      */
     facets?: Facet[];
     /**
      * @property fieldFilters
-     * @description A set of field filters applied to the data.
+     * @description Contains mutable field filters applied to data requests.
      * @type {any}
      */
     fieldFilters: any;
     /**
      * @property fieldOperators
-     * @description A set of field operators used for filtering.
+     * @description Contains operators associated with field-based filtering.
      * @type {any}
      */
     fieldOperators: any;
     /**
      * @property staticFieldFilters
-     * @description A set of static field filters applied to the data.
+     * @description Contains persistent field filters applied to every data request.
      * @type {any}
      */
     staticFieldFilters: any;
     /**
      * @property pageIndex
-     * @description The current page index for pagination.
+     * @description Stores the zero-based index of the current page.
      * @type {number}
      */
     pageIndex: number;
     /**
      * @property total
-     * @description The current total number of items being paged.
+     * @description Stores the total number of entities reported by the service.
      * @type {number}
      */
     total: number;
     /**
      * @property pageSize
-     * @description The number of items displayed per page in the data-table.
-     * It controls how many records are shown on a single page.
+     * @description Stores the number of entities requested per page.
      * @type {number}
      */
     pageSize: number;
     /**
      * @property pageCount
-     * @description The total number of pages based on pagination.
+     * @description Stores the total number of pages reported by the service.
      * @type {number}
      */
     pageCount: number;
     /**
      * @property isLoading
-     * @description Flag to show the loading process when the data is being fetched.
+     * @description Indicates whether a data request is currently in progress.
      * @type {boolean}
      */
     isLoading: boolean;
     /**
      * @constructor
-     * @description Initializes a new instance of the class and sets up the service, paginator, and sorter.
-     * The paginator and sorter are optional parameters used for handling pagination and sorting logic
-     * for the data displayed in the table.
-     * @param {TService} service - The service used for fetching and managing data.
-     * @param {MatPaginator} [paginator] - The paginator instance used for pagination functionality.
-     * @param {MatSort} [sorter] - The MatSort instance used for sorting functionality.
+     * @description Creates a data source backed by the supplied service and optional Material
+     * pagination and sorting controllers.
+     * @param {TService} service - The service used to retrieve table data.
+     * @param {MatPaginator} [paginator] - The controller used for server-side pagination.
+     * @param {MatSort} [sorter] - The controller used for server-side sorting.
      */
     constructor(service: TService, paginator?: MatPaginator | undefined, sorter?: MatSort | undefined);
     /**
-     * Connects a collection viewer (such as a data-table) to this data source.
-     * @param _ The component that exposes a view over the data provided by this
-     *     data source.
-     * @returns Observable that emits a new value when the data changes.
+     * @method connect
+     * @description Connects a collection viewer and reloads server data when sorting,
+     * pagination, filtering, or the reload token changes.
+     * @param {CollectionViewer} [_] - The viewer that consumes the emitted entities.
+     * @returns {Observable<TEntity[]>} An observable that emits the current page of entities.
      */
     connect(_?: CollectionViewer): Observable<TEntity[]>;
     /**
-     * Disconnects a collection viewer (such as a data-table) from this data source. Can be used
-     * to perform any clean-up or tear-down operations when a view is being destroyed.
-     *
-     * @param _ The component that exposes a view over the data provided by this
-     *     data source.
+     * @method disconnect
+     * @description Marks the data source as disconnected from its collection viewer.
+     * @param {CollectionViewer} _ - The viewer that no longer consumes this data source.
+     * @returns {void}
      */
     disconnect(_: CollectionViewer): void;
     /**
-     * Reloads items
-     * @param clearSelection
+     * @method reload
+     * @description Requests fresh data and optionally clears the current row selection.
+     * @param {boolean} [clearSelection=true] - Whether to clear selected entities.
+     * @returns {void}
      */
     reload(clearSelection?: boolean): void;
     /**
-     * Clears field filters
+     * @method applyFilters
+     * @description Replaces the mutable field filters and requests fresh data.
+     * @param {any} [newFilters={}] - The field filters to apply.
+     * @returns {void}
      */
     applyFilters(newFilters?: any): void;
     /**
-     * Clears field filters
+     * @method clearFilters
+     * @description Resets mutable field filters to the supplied object, or to an empty object
+     * when no replacement is supplied, and requests fresh data.
+     * @param {any} [newFilters={}] - Optional field filters retained after the reset.
+     * @returns {void}
      */
     clearFilters(newFilters?: any): void;
     /**
-     * Checks, whether all items are selected
+     * @method isAllSelected
+     * @description Determines whether the selected entity count matches the total entity count.
+     * An empty selection is never considered complete.
+     * @returns {boolean} `true` when every reported entity is selected; otherwise, `false`.
      */
     isAllSelected(): boolean;
     /**
-     * Toggles selected items
-     * @param checkbox
-     * @param predicate
+     * @method toggleSelect
+     * @description Clears an existing selection or selects each unlocked entity on the current
+     * page that satisfies the optional predicate.
+     * @param {MatCheckboxChange} checkbox - The select-all checkbox change event.
+     * @param {(value: TEntity, index: number, array: TEntity[]) => unknown} [predicate] - Optional
+     * condition used to choose selectable entities.
+     * @returns {void}
      */
     toggleSelect(checkbox: MatCheckboxChange, predicate?: (value: TEntity, index: number, array: TEntity[]) => unknown): void;
     /**
-     * Get selected Items
+     * @property getSelected
+     * @description Maps selected entities to the values stored under the specified property key.
+     * @template TType - The expected property value type.
+     * @param {string} key - The entity property key to read.
+     * @returns {TType[]} The selected property values.
      */
     getSelected: <TType>(key: string) => TType[];
     /**
-     * Get selected Items
+     * @property getSelectedItems
+     * @description Gets all currently selected entities.
+     * @returns {TEntity[]} The selected entities.
+     */
+    getSelectedItems: () => TEntity[];
+    /**
+     * @property getSelectedIds
+     * @description Gets the numeric identifiers of all selected entities.
+     * @returns {number[]} The selected entity identifiers.
      */
     getSelectedIds: () => number[];
 }
@@ -6387,7 +6415,7 @@ declare abstract class GenericFormBaseComponent<TEntity extends IEntity, TServic
      * Emitted when the form has been fully initialized
      * and is ready to be accessed or modified.
      */
-    formInitialized: EventEmitter<FormGroup<any> | NgForm>;
+    formInitialized: EventEmitter<NgForm | FormGroup<any>>;
     /**
      * The current date.
      */