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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -942,6 +942,10 @@ interface IBaseComponent {
942
942
  * Navigates back to the return URL if it exists.
943
943
  */
944
944
  navigateToReturnUrl(): void;
945
+ /**
946
+ * Navigates to the previous page in browser history.
947
+ */
948
+ navigateBack(): void;
945
949
  /**
946
950
  * Shows a confirmation dialog to send some data.
947
951
  *
@@ -1253,6 +1257,10 @@ declare abstract class BaseComponent implements IBaseComponent, OnInit, AfterVie
1253
1257
  * Navigates back to the return URL if it exists.
1254
1258
  */
1255
1259
  navigateToReturnUrl(): void;
1260
+ /**
1261
+ * Navigates to the previous page in browser history.
1262
+ */
1263
+ navigateBack(): void;
1256
1264
  /**
1257
1265
  * Expands the specified expansion panel path (supporting nested IDs) and collapses others.
1258
1266
  * @param panelPath - The dot-separated ID path (e.g., 'warehouse.orders.details').
@@ -3414,6 +3422,11 @@ declare class TableColumn<TEntity = any> {
3414
3422
  * @property
3415
3423
  */
3416
3424
  multiple?: boolean;
3425
+ /**
3426
+ * The property of the entity that this column represents.
3427
+ * @property
3428
+ */
3429
+ property?: string;
3417
3430
  /**
3418
3431
  * The name of the column.
3419
3432
  * @property
@@ -3500,6 +3513,29 @@ declare class TableColumn<TEntity = any> {
3500
3513
  constructor(init?: Partial<TableColumn<TEntity>>);
3501
3514
  }
3502
3515
 
3516
+ /**
3517
+ * Interface for mutation options used in create, update, patch, and delete operations.
3518
+ */
3519
+ interface MutationOptions {
3520
+ /**
3521
+ * httpOptions: Object
3522
+ * Optional HTTP options (headers, etc.)
3523
+ * @type {Object}
3524
+ */
3525
+ httpOptions?: Object;
3526
+ /**
3527
+ * handleError: boolean
3528
+ * Whether to handle errors (default: true)
3529
+ * @type {boolean}
3530
+ */
3531
+ handleError?: boolean;
3532
+ /**
3533
+ * showMessage: boolean
3534
+ * Whether to show a message after the operation (default: false)
3535
+ * @type {boolean}
3536
+ */
3537
+ showMessage?: boolean;
3538
+ }
3503
3539
  declare class GenericService<T extends any> {
3504
3540
  endpoint?: string | undefined;
3505
3541
  /**
@@ -3523,14 +3559,14 @@ declare class GenericService<T extends any> {
3523
3559
  * @param handleError Whether to handle errors (default: true)
3524
3560
  * @param observeResponse Whether to observe the full response (default: false)
3525
3561
  */
3526
- get<T>(id: string | number, params?: Object | null, headers?: Object, handleError?: boolean, observeResponse?: boolean): Observable<any>;
3562
+ get<T>(id: string | number, params?: HttpParams | Object | null, headers?: Object, handleError?: boolean, observeResponse?: boolean): Observable<any>;
3527
3563
  /**
3528
3564
  * Asynchronously retrieves a single entity by ID or relative path
3529
3565
  * @param id The entity ID or relative path
3530
3566
  * @param params Optional query parameters
3531
3567
  * @returns Promise resolving to the entity
3532
3568
  */
3533
- getAsync<T>(id: string | number, params?: Object | null): Promise<T>;
3569
+ getAsync<T>(id: string | number, params?: HttpParams | Object | null): Promise<T>;
3534
3570
  /**
3535
3571
  * Counts entities on the server
3536
3572
  * @param params Optional query parameters
@@ -3588,106 +3624,250 @@ declare class GenericService<T extends any> {
3588
3624
  getListAsObservable(): Observable<any>;
3589
3625
  /**
3590
3626
  * Creates a new entity
3627
+ *
3628
+ * Overload 1 (legacy): use httpOptions + handleError + showMessage parameters.
3591
3629
  * @param entity The entity to create
3592
3630
  * @param path Optional relative path to the action
3593
3631
  * @param httpOptions Optional HTTP options (headers, etc.)
3594
3632
  * @param handleError Whether to handle errors (default: true)
3595
3633
  */
3596
- create<T>(entity: any, path?: string | null, httpOptions?: Object, handleError?: boolean): Observable<T>;
3634
+ create<T>(entity: any, path?: string | null, httpOptions?: Object, handleError?: boolean, showMessage?: boolean): Observable<T>;
3635
+ /**
3636
+ * Creates a new entity
3637
+ *
3638
+ * Overload 2 (preferred): use a single options object.
3639
+ * @param entity The entity to create
3640
+ * @param path Optional relative path to the action
3641
+ * @param options Wrapper containing httpOptions, handleError and showMessage
3642
+ */
3643
+ create<T>(entity: any, path?: string | null, options?: MutationOptions): Observable<T>;
3597
3644
  /**
3598
3645
  * Asynchronously creates a new entity
3646
+ *
3647
+ * Overload 1 (legacy): use httpOptions + showMessage parameters.
3599
3648
  * @param entity The entity to create
3600
3649
  * @param path Optional relative path to the action
3601
3650
  * @param httpOptions Optional HTTP options (headers, etc.)
3602
3651
  * @returns Promise resolving to the created entity
3603
3652
  */
3604
- createAsync<T>(entity: any, path?: string | null, httpOptions?: Object): Promise<T>;
3653
+ createAsync<T>(entity: any, path?: string | null, httpOptions?: Object, showMessage?: boolean): Promise<T>;
3654
+ /**
3655
+ * Asynchronously creates a new entity
3656
+ *
3657
+ * Overload 2 (preferred): use a single options object.
3658
+ * @param entity The entity to create
3659
+ * @param path Optional relative path to the action
3660
+ * @param options Wrapper containing httpOptions, handleError and showMessage
3661
+ * @returns Promise resolving to the created entity
3662
+ */
3663
+ createAsync<T>(entity: any, path?: string | null, options?: MutationOptions): Promise<T>;
3605
3664
  /**
3606
3665
  * Updates an existing entity asynchronously
3666
+ *
3667
+ * Overload 1 (legacy): use httpOptions + handleError + showMessage parameters.
3607
3668
  * @param id The ID of the entity to update
3608
3669
  * @param entity The updated entity data
3609
3670
  * @param path Optional relative path to the action
3610
3671
  * @param httpOptions Optional HTTP options (headers, etc.)
3611
3672
  * @param handleError Whether to handle errors (default: true)
3612
3673
  */
3613
- update(id: string | number, entity: any, path?: string | null, httpOptions?: Object, handleError?: boolean): Observable<any>;
3674
+ update(id: string | number, entity: any, path?: string | null, httpOptions?: Object, handleError?: boolean, showMessage?: boolean): Observable<any>;
3675
+ /**
3676
+ * Updates an existing entity asynchronously
3677
+ *
3678
+ * Overload 2 (preferred): use a single options object.
3679
+ * @param id The ID of the entity to update
3680
+ * @param entity The updated entity data
3681
+ * @param path Optional relative path to the action
3682
+ * @param options Wrapper containing httpOptions, handleError and showMessage
3683
+ */
3684
+ update(id: string | number, entity: any, path?: string | null, options?: MutationOptions): Observable<any>;
3614
3685
  /**
3615
3686
  * Asynchronously updates an existing entity
3687
+ *
3688
+ * Overload 1 (legacy): use httpOptions + showMessage parameters.
3616
3689
  * @param id The ID of the entity to update
3617
3690
  * @param entity The updated entity data
3618
3691
  * @param path Optional relative path to the action
3619
3692
  * @param httpOptions Optional HTTP options (headers, etc.)
3620
3693
  * @returns Promise resolving to the updated entity
3621
3694
  */
3622
- updateAsync(id: string | number, entity: any, path?: string | null, httpOptions?: Object): Promise<any>;
3695
+ updateAsync(id: string | number, entity: any, path?: string | null, httpOptions?: Object, showMessage?: boolean): Promise<any>;
3696
+ /**
3697
+ * Asynchronously updates an existing entity
3698
+ *
3699
+ * Overload 2 (preferred): use a single options object.
3700
+ * @param id The ID of the entity to update
3701
+ * @param entity The updated entity data
3702
+ * @param path Optional relative path to the action
3703
+ * @param options Wrapper containing httpOptions, handleError and showMessage
3704
+ * @returns Promise resolving to the updated entity
3705
+ */
3706
+ updateAsync(id: string | number, entity: any, path?: string | null, options?: MutationOptions): Promise<any>;
3623
3707
  /**
3624
3708
  * Applies a JSON Patch to an entity
3709
+ *
3710
+ * Overload 1 (legacy): use httpOptions + handleError + showMessage parameters.
3625
3711
  * @param id The ID of the item to patch
3626
3712
  * @param body The patch body
3627
3713
  * @param path Optional relative path to the action
3628
3714
  * @param httpOptions Optional HTTP options (headers, etc.)
3629
3715
  * @param handleError Whether to handle errors (default: true)
3630
3716
  */
3631
- patch(id: string | number, body: any, path?: string | null, httpOptions?: any, handleError?: boolean): Observable<any>;
3717
+ patch(id: string | number, body: any, path?: string | null, httpOptions?: any, handleError?: boolean, showMessage?: boolean): Observable<any>;
3718
+ /**
3719
+ * Applies a JSON Patch to an entity
3720
+ *
3721
+ * Overload 2 (preferred): use a single options object.
3722
+ * @param id The ID of the item to patch
3723
+ * @param body The patch body
3724
+ * @param path Optional relative path to the action
3725
+ * @param options Wrapper containing httpOptions, handleError and showMessage
3726
+ */
3727
+ patch(id: string | number, body: any, path?: string | null, options?: MutationOptions): Observable<any>;
3632
3728
  /**
3633
3729
  * Asynchronously applies a JSON Patch to an entity
3730
+ *
3731
+ * Overload 1 (legacy): use httpOptions + showMessage parameters.
3634
3732
  * @param id The ID of the item to patch
3635
3733
  * @param body The patch body
3636
3734
  * @param path Optional relative path to the action
3637
3735
  * @param httpOptions Optional HTTP options (headers, etc.)
3638
3736
  * @returns Promise resolving to the patched entity
3639
3737
  */
3640
- patchAsync(id: string | number, body: any, path?: string | null, httpOptions?: any): Promise<any>;
3738
+ patchAsync(id: string | number, body: any, path?: string | null, httpOptions?: any, showMessage?: boolean): Promise<any>;
3739
+ /**
3740
+ * Asynchronously applies a JSON Patch to an entity
3741
+ *
3742
+ * Overload 2 (preferred): use a single options object.
3743
+ * @param id The ID of the item to patch
3744
+ * @param body The patch body
3745
+ * @param path Optional relative path to the action
3746
+ * @param options Wrapper containing httpOptions, handleError and showMessage
3747
+ * @returns Promise resolving to the patched entity
3748
+ */
3749
+ patchAsync(id: string | number, body: any, path?: string | null, options?: MutationOptions): Promise<any>;
3641
3750
  /**
3642
3751
  * Applies a JSON Patch to multiple entities
3752
+ *
3753
+ * Overload 1 (legacy): use httpOptions + handleError + showMessage parameters.
3643
3754
  * @param ids The IDs of the items to patch
3644
3755
  * @param body The patch body
3645
3756
  * @param path Optional relative path to the action
3646
3757
  * @param httpOptions Optional HTTP options (headers, etc.)
3647
3758
  * @param handleError Whether to handle errors (default: true)
3648
3759
  */
3649
- patchList(ids: string[] | number[], body: any, path?: string | null, httpOptions?: Object, handleError?: boolean): Observable<any>;
3760
+ patchList(ids: string[] | number[], body: any, path?: string | null, httpOptions?: Object, handleError?: boolean, showMessage?: boolean): Observable<any>;
3761
+ /**
3762
+ * Applies a JSON Patch to multiple entities
3763
+ *
3764
+ * Overload 2 (preferred): use a single options object.
3765
+ * @param ids The IDs of the items to patch
3766
+ * @param body The patch body
3767
+ * @param path Optional relative path to the action
3768
+ * @param options Wrapper containing httpOptions, handleError and showMessage
3769
+ */
3770
+ patchList(ids: string[] | number[], body: any, path?: string | null, options?: MutationOptions): Observable<any>;
3650
3771
  /**
3651
3772
  * Asynchronously applies a JSON Patch to multiple entities
3773
+ *
3774
+ * Overload 1 (legacy): use httpOptions + showMessage parameters.
3652
3775
  * @param ids The IDs of the items to patch
3653
3776
  * @param body The patch body
3654
3777
  * @param path Optional relative path to the action
3655
3778
  * @param httpOptions Optional HTTP options (headers, etc.)
3656
3779
  * @returns Promise resolving to the patched entities
3657
3780
  */
3658
- patchListAsync(ids: string[] | number[], body: any, path?: string | null, httpOptions?: Object): Promise<any>;
3781
+ patchListAsync(ids: string[] | number[], body: any, path?: string | null, httpOptions?: Object, showMessage?: boolean): Promise<any>;
3782
+ /**
3783
+ * Asynchronously applies a JSON Patch to multiple entities
3784
+ *
3785
+ * Overload 2 (preferred): use a single options object.
3786
+ * @param ids The IDs of the items to patch
3787
+ * @param body The patch body
3788
+ * @param path Optional relative path to the action
3789
+ * @param options Wrapper containing httpOptions, handleError and showMessage
3790
+ * @returns Promise resolving to the patched entities
3791
+ */
3792
+ patchListAsync(ids: string[] | number[], body: any, path?: string | null, options?: MutationOptions): Promise<any>;
3659
3793
  /**
3660
3794
  * Deletes an entity by ID
3795
+ *
3796
+ * Overload 1 (legacy): use httpOptions + handleError + showMessage parameters.
3661
3797
  * @param id The ID of the item to delete
3662
3798
  * @param path Optional relative path to the action
3663
3799
  * @param httpOptions Optional HTTP options (headers, etc.)
3664
3800
  * @param handleError Whether to handle errors (default: true)
3665
3801
  */
3666
- delete(id: string | number, path?: string | null, httpOptions?: Object, handleError?: boolean): Observable<any>;
3802
+ delete(id: string | number, path?: string | null, httpOptions?: Object, handleError?: boolean, showMessage?: boolean): Observable<any>;
3803
+ /**
3804
+ * Deletes an entity by ID
3805
+ *
3806
+ * Overload 2 (preferred): use a single options object.
3807
+ * @param id The ID of the item to delete
3808
+ * @param path Optional relative path to the action
3809
+ * @param options Wrapper containing httpOptions, handleError and showMessage
3810
+ */
3811
+ delete(id: string | number, path?: string | null, options?: MutationOptions): Observable<any>;
3667
3812
  /**
3668
3813
  * Asynchronously deletes an entity by ID
3814
+ *
3815
+ * Overload 1 (legacy): use httpOptions + showMessage parameters.
3669
3816
  * @param id The ID of the item to delete
3670
3817
  * @param path Optional relative path to the action
3671
3818
  * @param httpOptions Optional HTTP options (headers, etc.)
3672
3819
  * @returns Promise resolving to the delete result
3673
3820
  */
3674
- deleteAsync(id: string | number, path?: string | null, httpOptions?: Object): Promise<any>;
3821
+ deleteAsync(id: string | number, path?: string | null, httpOptions?: Object, showMessage?: boolean): Promise<any>;
3822
+ /**
3823
+ * Asynchronously deletes an entity by ID
3824
+ *
3825
+ * Overload 2 (preferred): use a single options object.
3826
+ * @param id The ID of the item to delete
3827
+ * @param path Optional relative path to the action
3828
+ * @param options Wrapper containing httpOptions, handleError and showMessage
3829
+ * @returns Promise resolving to the delete result
3830
+ */
3831
+ deleteAsync(id: string | number, path?: string | null, options?: MutationOptions): Promise<any>;
3675
3832
  /**
3676
3833
  * Deletes multiple entities by IDs
3834
+ *
3835
+ * Overload 1 (legacy): use httpOptions + handleError + showMessage parameters.
3677
3836
  * @param ids The IDs of the items to delete
3678
3837
  * @param path Optional relative path to the action
3679
3838
  * @param httpOptions Optional HTTP options (headers, etc.)
3680
3839
  * @param handleError Whether to handle errors (default: true)
3681
3840
  */
3682
- deleteList(ids: string[] | number[], path?: string | null, httpOptions?: Object, handleError?: boolean): Observable<any>;
3841
+ deleteList(ids: string[] | number[], path?: string | null, httpOptions?: Object, handleError?: boolean, showMessage?: boolean): Observable<any>;
3842
+ /**
3843
+ * Deletes multiple entities by IDs
3844
+ *
3845
+ * Overload 2 (preferred): use a single options object.
3846
+ * @param ids The IDs of the items to delete
3847
+ * @param path Optional relative path to the action
3848
+ * @param options Wrapper containing httpOptions, handleError and showMessage
3849
+ */
3850
+ deleteList(ids: string[] | number[], path?: string | null, options?: MutationOptions): Observable<any>;
3683
3851
  /**
3684
3852
  * Asynchronously deletes multiple entities by IDs
3853
+ *
3854
+ * Overload 1 (legacy): use httpOptions + showMessage parameters.
3685
3855
  * @param ids The IDs of the items to delete
3686
3856
  * @param path Optional relative path to the action
3687
3857
  * @param httpOptions Optional HTTP options (headers, etc.)
3688
3858
  * @returns Promise resolving to the delete result
3689
3859
  */
3690
- deleteListAsync(ids: string[] | number[], path?: string | null, httpOptions?: Object): Promise<any>;
3860
+ deleteListAsync(ids: string[] | number[], path?: string | null, httpOptions?: Object, showMessage?: boolean): Promise<any>;
3861
+ /**
3862
+ * Asynchronously deletes multiple entities by IDs
3863
+ *
3864
+ * Overload 2 (preferred): use a single options object.
3865
+ * @param ids The IDs of the items to delete
3866
+ * @param path Optional relative path to the action
3867
+ * @param options Wrapper containing httpOptions, handleError and showMessage
3868
+ * @returns Promise resolving to the delete result
3869
+ */
3870
+ deleteListAsync(ids: string[] | number[], path?: string | null, options?: MutationOptions): Promise<any>;
3691
3871
  /**
3692
3872
  * Downloads a file from the server
3693
3873
  * @param path Relative path to the download action
@@ -3708,13 +3888,13 @@ declare class GenericService<T extends any> {
3708
3888
  * Duplicates a record by ID
3709
3889
  * @param id The ID of the record to duplicate
3710
3890
  */
3711
- duplicate(id: number): Observable<any>;
3891
+ duplicate(id: number, showMessage?: boolean): Observable<any>;
3712
3892
  /**
3713
3893
  * Asynchronously duplicates a record by ID
3714
3894
  * @param id The ID of the record to duplicate
3715
3895
  * @returns Promise resolving to the duplicated record
3716
3896
  */
3717
- duplicateAsync(id: number): Promise<any>;
3897
+ duplicateAsync(id: number, showMessage?: boolean): Promise<any>;
3718
3898
  /**
3719
3899
  * Uploads a file to the server
3720
3900
  * @param file The file to upload
@@ -3743,6 +3923,21 @@ declare class GenericService<T extends any> {
3743
3923
  * @returns HttpHeaders instance
3744
3924
  */
3745
3925
  protected toHttpHeaders(body?: Object | null): HttpHeaders;
3926
+ /**
3927
+ * Adds the Show-Message header to request options when enabled
3928
+ * @param httpOptions Existing HTTP options
3929
+ * @param showMessage Whether to add the Show-Message header
3930
+ * @returns HTTP options with optional Show-Message header
3931
+ */
3932
+ protected withShowMessage(httpOptions?: any, showMessage?: boolean): any;
3933
+ /**
3934
+ * Normalizes legacy mutation arguments and options-object overload arguments
3935
+ * @param optionsOrHttpOptions Legacy httpOptions or options object
3936
+ * @param handleError Legacy handleError value
3937
+ * @param showMessage Legacy showMessage value
3938
+ * @returns Normalized mutation options
3939
+ */
3940
+ protected resolveMutationOptions(optionsOrHttpOptions?: Object | MutationOptions, handleError?: boolean, showMessage?: boolean): Required<MutationOptions>;
3746
3941
  /**
3747
3942
  * Normalizes the 'projection' parameter in query parameters
3748
3943
  * @param params The query parameters (HttpParams or object)
@@ -3858,7 +4053,11 @@ declare class Pagination<TModel> {
3858
4053
  }
3859
4054
 
3860
4055
  /**
3861
- * A generic datasource for data-table
4056
+ * @class TableDataSource
4057
+ * @description Provides a server-backed data source with filtering, sorting, pagination,
4058
+ * reloading, and row selection for an Angular Material table.
4059
+ * @template TEntity - The entity type displayed by the table.
4060
+ * @template TService - The service type used to retrieve entities.
3862
4061
  */
3863
4062
  declare class TableDataSource<TEntity, TService extends GenericService<TEntity>> extends DataSource<TEntity> {
3864
4063
  service: TService;
@@ -3866,214 +4065,238 @@ declare class TableDataSource<TEntity, TService extends GenericService<TEntity>>
3866
4065
  sorter?: MatSort | undefined;
3867
4066
  /**
3868
4067
  * @property _filterChange
3869
- * @description Represents a value that changes over time.
3870
- * Observers can subscribe to this BehaviorSubject to receive filter changes.
4068
+ * @description Stores and emits the current free-text filter.
3871
4069
  * @type {BehaviorSubject<string>}
3872
4070
  */
3873
4071
  private _filterChange;
3874
4072
  /**
3875
4073
  * @property _reloadChange
3876
- * @description Represents a value that triggers reload actions.
3877
- * It is used to notify when a reload should occur by emitting a new value.
4074
+ * @description Emits a new token whenever the table data must be reloaded.
3878
4075
  * @type {BehaviorSubject<number>}
3879
4076
  */
3880
4077
  _reloadChange: BehaviorSubject<number>;
3881
4078
  /**
3882
4079
  * @property onDataLoaded
3883
- * @description Event emitted after the data is loaded.
3884
- * It is a BehaviorSubject that holds pagination data or a null value if no data is loaded.
4080
+ * @description Emits the latest pagination response after data loads successfully.
4081
+ * The initial value is `null` until the first response is received.
3885
4082
  * @type {BehaviorSubject<Pagination<TEntity> | any>}
3886
4083
  */
3887
4084
  onDataLoaded: BehaviorSubject<Pagination<TEntity> | any>;
3888
4085
  /**
3889
4086
  * @property selectionModel
3890
- * @description Used to power selecting one or more options from a list.
4087
+ * @description Tracks the entities selected across the table.
3891
4088
  * @type {SelectionModel<TEntity>}
3892
4089
  */
3893
4090
  selectionModel: SelectionModel<TEntity>;
3894
4091
  /**
3895
4092
  * @property filter
3896
- * @description Gets the current filter applied to the data.
4093
+ * @description Gets the current free-text filter.
3897
4094
  * @type {string}
3898
4095
  */
3899
4096
  get filter(): string;
3900
4097
  /**
3901
4098
  * @property filter
3902
- * @description Sets the filter and resets the page index if the paginator exists.
3903
- * @param {string} filter - The filter value to be applied.
4099
+ * @description Sets the free-text filter and returns pagination to the first page.
4100
+ * @param {string} filter - The filter text to apply.
3904
4101
  */
3905
4102
  set filter(filter: string);
3906
4103
  /**
3907
4104
  * @property onSortChange
3908
- * @description Sort change event emitter used to notify changes in sorting.
4105
+ * @description Relays changes emitted by the assigned sort controller.
3909
4106
  * @type {EventEmitter<Sort>}
3910
4107
  */
3911
4108
  private onSortChange;
3912
4109
  /**
3913
4110
  * @property _sort
3914
- * @description Private instance of MatSort used to control the sorting of the table.
3915
- * @type {MatSort | null}
4111
+ * @description Stores the sort controller currently assigned to the data source.
4112
+ * @type {MatSort | undefined}
3916
4113
  */
3917
4114
  private _sort?;
3918
4115
  /**
3919
4116
  * @property sort
3920
- * @description Gets or sets the MatSort instance used to control the sorting of the table.
3921
- * Changes in sorting will trigger an update to the table’s rendered data.
4117
+ * @description Gets or sets the sort controller whose changes reload the table data.
3922
4118
  * @type {MatSort | undefined}
3923
4119
  */
3924
4120
  get sort(): MatSort | undefined;
3925
4121
  set sort(sort: MatSort | undefined);
3926
4122
  /**
3927
4123
  * @property reloadToken
3928
- * @description Gets the current reload token, used to trigger reload events.
4124
+ * @description Gets the token emitted by the most recent reload request.
3929
4125
  * @type {number}
3930
4126
  */
3931
4127
  get reloadToken(): number;
3932
4128
  /**
3933
4129
  * @property isConnected
3934
- * @description Flag indicating whether the data source is connected.
4130
+ * @description Indicates whether a collection viewer is connected to the data source.
3935
4131
  * @type {boolean}
3936
4132
  */
3937
4133
  isConnected: boolean;
3938
4134
  /**
3939
4135
  * @property includes
3940
- * @description The list of navigations to be included in the data query.
4136
+ * @description Lists the related resources to include in each data request.
3941
4137
  * @type {Array<string>}
3942
4138
  */
3943
4139
  includes: Array<string>;
3944
4140
  /**
3945
4141
  * @property path
3946
- * @description The endpoint path for the data source.
4142
+ * @description Specifies the optional service endpoint path used to retrieve data.
3947
4143
  * @type {string | undefined}
3948
4144
  */
3949
4145
  path?: string;
3950
4146
  /**
3951
4147
  * @property projection
3952
- * @description Defines the fields to be included in the data query projection.
4148
+ * @description Specifies the fields requested from the service, either as a comma-separated
4149
+ * string or an array of field names.
3953
4150
  * @type {string | string[]}
3954
4151
  */
3955
4152
  projection: string | string[];
3956
4153
  /**
3957
4154
  * @property items
3958
- * @description The list of items to be displayed in the data table.
4155
+ * @description Contains the entities returned for the current page.
3959
4156
  * @type {TEntity[]}
3960
4157
  */
3961
4158
  items: TEntity[];
3962
4159
  /**
3963
4160
  * @property parameters
3964
- * @description The parameters for pagination and sorting.
4161
+ * @description Contains additional parameters returned by the latest data request.
3965
4162
  * @type {any}
3966
4163
  */
3967
4164
  parameters?: any;
3968
4165
  /**
3969
4166
  * @property facets
3970
- * @description The list of facets for filtering items.
4167
+ * @description Contains the facets returned by the latest data request.
3971
4168
  * @type {Facet[] | undefined}
3972
4169
  */
3973
4170
  facets?: Facet[];
3974
4171
  /**
3975
4172
  * @property fieldFilters
3976
- * @description A set of field filters applied to the data.
4173
+ * @description Contains mutable field filters applied to data requests.
3977
4174
  * @type {any}
3978
4175
  */
3979
4176
  fieldFilters: any;
3980
4177
  /**
3981
4178
  * @property fieldOperators
3982
- * @description A set of field operators used for filtering.
4179
+ * @description Contains operators associated with field-based filtering.
3983
4180
  * @type {any}
3984
4181
  */
3985
4182
  fieldOperators: any;
3986
4183
  /**
3987
4184
  * @property staticFieldFilters
3988
- * @description A set of static field filters applied to the data.
4185
+ * @description Contains persistent field filters applied to every data request.
3989
4186
  * @type {any}
3990
4187
  */
3991
4188
  staticFieldFilters: any;
3992
4189
  /**
3993
4190
  * @property pageIndex
3994
- * @description The current page index for pagination.
4191
+ * @description Stores the zero-based index of the current page.
3995
4192
  * @type {number}
3996
4193
  */
3997
4194
  pageIndex: number;
3998
4195
  /**
3999
4196
  * @property total
4000
- * @description The current total number of items being paged.
4197
+ * @description Stores the total number of entities reported by the service.
4001
4198
  * @type {number}
4002
4199
  */
4003
4200
  total: number;
4004
4201
  /**
4005
4202
  * @property pageSize
4006
- * @description The number of items displayed per page in the data-table.
4007
- * It controls how many records are shown on a single page.
4203
+ * @description Stores the number of entities requested per page.
4008
4204
  * @type {number}
4009
4205
  */
4010
4206
  pageSize: number;
4011
4207
  /**
4012
4208
  * @property pageCount
4013
- * @description The total number of pages based on pagination.
4209
+ * @description Stores the total number of pages reported by the service.
4014
4210
  * @type {number}
4015
4211
  */
4016
4212
  pageCount: number;
4017
4213
  /**
4018
4214
  * @property isLoading
4019
- * @description Flag to show the loading process when the data is being fetched.
4215
+ * @description Indicates whether a data request is currently in progress.
4020
4216
  * @type {boolean}
4021
4217
  */
4022
4218
  isLoading: boolean;
4023
4219
  /**
4024
4220
  * @constructor
4025
- * @description Initializes a new instance of the class and sets up the service, paginator, and sorter.
4026
- * The paginator and sorter are optional parameters used for handling pagination and sorting logic
4027
- * for the data displayed in the table.
4028
- * @param {TService} service - The service used for fetching and managing data.
4029
- * @param {MatPaginator} [paginator] - The paginator instance used for pagination functionality.
4030
- * @param {MatSort} [sorter] - The MatSort instance used for sorting functionality.
4221
+ * @description Creates a data source backed by the supplied service and optional Material
4222
+ * pagination and sorting controllers.
4223
+ * @param {TService} service - The service used to retrieve table data.
4224
+ * @param {MatPaginator} [paginator] - The controller used for server-side pagination.
4225
+ * @param {MatSort} [sorter] - The controller used for server-side sorting.
4031
4226
  */
4032
4227
  constructor(service: TService, paginator?: MatPaginator | undefined, sorter?: MatSort | undefined);
4033
4228
  /**
4034
- * Connects a collection viewer (such as a data-table) to this data source.
4035
- * @param _ The component that exposes a view over the data provided by this
4036
- * data source.
4037
- * @returns Observable that emits a new value when the data changes.
4229
+ * @method connect
4230
+ * @description Connects a collection viewer and reloads server data when sorting,
4231
+ * pagination, filtering, or the reload token changes.
4232
+ * @param {CollectionViewer} [_] - The viewer that consumes the emitted entities.
4233
+ * @returns {Observable<TEntity[]>} An observable that emits the current page of entities.
4038
4234
  */
4039
4235
  connect(_?: CollectionViewer): Observable<TEntity[]>;
4040
4236
  /**
4041
- * Disconnects a collection viewer (such as a data-table) from this data source. Can be used
4042
- * to perform any clean-up or tear-down operations when a view is being destroyed.
4043
- *
4044
- * @param _ The component that exposes a view over the data provided by this
4045
- * data source.
4237
+ * @method disconnect
4238
+ * @description Marks the data source as disconnected from its collection viewer.
4239
+ * @param {CollectionViewer} _ - The viewer that no longer consumes this data source.
4240
+ * @returns {void}
4046
4241
  */
4047
4242
  disconnect(_: CollectionViewer): void;
4048
4243
  /**
4049
- * Reloads items
4050
- * @param clearSelection
4244
+ * @method reload
4245
+ * @description Requests fresh data and optionally clears the current row selection.
4246
+ * @param {boolean} [clearSelection=true] - Whether to clear selected entities.
4247
+ * @returns {void}
4051
4248
  */
4052
4249
  reload(clearSelection?: boolean): void;
4053
4250
  /**
4054
- * Clears field filters
4251
+ * @method applyFilters
4252
+ * @description Replaces the mutable field filters and requests fresh data.
4253
+ * @param {any} [newFilters={}] - The field filters to apply.
4254
+ * @returns {void}
4055
4255
  */
4056
4256
  applyFilters(newFilters?: any): void;
4057
4257
  /**
4058
- * Clears field filters
4258
+ * @method clearFilters
4259
+ * @description Resets mutable field filters to the supplied object, or to an empty object
4260
+ * when no replacement is supplied, and requests fresh data.
4261
+ * @param {any} [newFilters={}] - Optional field filters retained after the reset.
4262
+ * @returns {void}
4059
4263
  */
4060
4264
  clearFilters(newFilters?: any): void;
4061
4265
  /**
4062
- * Checks, whether all items are selected
4266
+ * @method isAllSelected
4267
+ * @description Determines whether the selected entity count matches the total entity count.
4268
+ * An empty selection is never considered complete.
4269
+ * @returns {boolean} `true` when every reported entity is selected; otherwise, `false`.
4063
4270
  */
4064
4271
  isAllSelected(): boolean;
4065
4272
  /**
4066
- * Toggles selected items
4067
- * @param checkbox
4068
- * @param predicate
4273
+ * @method toggleSelect
4274
+ * @description Clears an existing selection or selects each unlocked entity on the current
4275
+ * page that satisfies the optional predicate.
4276
+ * @param {MatCheckboxChange} checkbox - The select-all checkbox change event.
4277
+ * @param {(value: TEntity, index: number, array: TEntity[]) => unknown} [predicate] - Optional
4278
+ * condition used to choose selectable entities.
4279
+ * @returns {void}
4069
4280
  */
4070
4281
  toggleSelect(checkbox: MatCheckboxChange, predicate?: (value: TEntity, index: number, array: TEntity[]) => unknown): void;
4071
4282
  /**
4072
- * Get selected Items
4283
+ * @property getSelected
4284
+ * @description Maps selected entities to the values stored under the specified property key.
4285
+ * @template TType - The expected property value type.
4286
+ * @param {string} key - The entity property key to read.
4287
+ * @returns {TType[]} The selected property values.
4073
4288
  */
4074
4289
  getSelected: <TType>(key: string) => TType[];
4075
4290
  /**
4076
- * Get selected Items
4291
+ * @property getSelectedItems
4292
+ * @description Gets all currently selected entities.
4293
+ * @returns {TEntity[]} The selected entities.
4294
+ */
4295
+ getSelectedItems: () => TEntity[];
4296
+ /**
4297
+ * @property getSelectedIds
4298
+ * @description Gets the numeric identifiers of all selected entities.
4299
+ * @returns {number[]} The selected entity identifiers.
4077
4300
  */
4078
4301
  getSelectedIds: () => number[];
4079
4302
  }
@@ -4293,6 +4516,10 @@ declare class VdDynamicTableComponent implements OnInit, AfterViewChecked {
4293
4516
  * Observable tracking the filterable columns displayed in the table.
4294
4517
  */
4295
4518
  displayedFilterColumns$?: Observable<string[]>;
4519
+ /**
4520
+ * Name of the last visible sticky-start column used as right boundary marker.
4521
+ */
4522
+ lastStickyStartColumnName?: string;
4296
4523
  /**
4297
4524
  * Input property for row-specific action menu items.
4298
4525
  * Defines actions available in the context menu for each row.
@@ -4380,10 +4607,21 @@ declare class VdDynamicTableComponent implements OnInit, AfterViewChecked {
4380
4607
  trackBy(index: number, item: any): string;
4381
4608
  /**
4382
4609
  * A function to to compute the identity of items in an iterable.
4383
- * @param index
4384
- * @param item
4610
+ * @param index The index of the column in the array
4611
+ * @param item The column item itself
4385
4612
  */
4386
4613
  columnsTrackBy(index: number, item: any): string;
4614
+ /**
4615
+ * Checks if the given column is the last sticky start column
4616
+ * @param column The column to check
4617
+ * @returns True if it is the last sticky start column, false otherwise
4618
+ */
4619
+ isLastStickyStartColumn(column: TableColumn): boolean;
4620
+ /**
4621
+ * Updates the name of the last sticky start column based on the current visible columns.
4622
+ * @param columns The array of table columns to evaluate.
4623
+ */
4624
+ private updateLastStickyStartColumnName;
4387
4625
  /**
4388
4626
  * Handles row click event
4389
4627
  * @param index
@@ -5144,7 +5382,7 @@ declare abstract class GenericListComponent<TEntity extends IEntity | any, TServ
5144
5382
  */
5145
5383
  get [Symbol.toStringTag](): string;
5146
5384
  static ɵfac: i0.ɵɵFactoryDeclaration<GenericListComponent<any, any>, never>;
5147
- static ɵdir: i0.ɵɵDirectiveDeclaration<GenericListComponent<any, any>, never, never, { "backButton": { "alias": "backButton"; "required": false; }; }, {}, never, never, true, never>;
5385
+ static ɵdir: i0.ɵɵDirectiveDeclaration<GenericListComponent<any, any>, never, never, { "columnSets": { "alias": "columnSets"; "required": false; }; "selectable": { "alias": "selectable"; "required": false; }; "addable": { "alias": "addable"; "required": false; }; "editable": { "alias": "editable"; "required": false; }; "deletable": { "alias": "deletable"; "required": false; }; "downloadable": { "alias": "downloadable"; "required": false; }; "duplicable": { "alias": "duplicable"; "required": false; }; "configurable": { "alias": "configurable"; "required": false; }; "exportable": { "alias": "exportable"; "required": false; }; "exportFileName": { "alias": "exportFileName"; "required": false; }; "sticky": { "alias": "sticky"; "required": false; }; "backButton": { "alias": "backButton"; "required": false; }; }, {}, never, never, true, never>;
5148
5386
  }
5149
5387
 
5150
5388
  /**
@@ -5798,6 +6036,11 @@ declare class FormFieldDefinition<TEntity = any, TProperty = any> {
5798
6036
  * Defaults to true.
5799
6037
  */
5800
6038
  defaultOption?: boolean;
6039
+ /**
6040
+ * Predicate used to resolve the default option(s) from loaded options.
6041
+ * Return true for the option(s) that should be preselected.
6042
+ */
6043
+ default?: (option: any) => boolean;
5801
6044
  /**
5802
6045
  * Template function for rendering options in the selection.
5803
6046
  * @param x The current property value.
@@ -6172,7 +6415,7 @@ declare abstract class GenericFormBaseComponent<TEntity extends IEntity, TServic
6172
6415
  * Emitted when the form has been fully initialized
6173
6416
  * and is ready to be accessed or modified.
6174
6417
  */
6175
- formInitialized: EventEmitter<FormGroup<any> | NgForm>;
6418
+ formInitialized: EventEmitter<NgForm | FormGroup<any>>;
6176
6419
  /**
6177
6420
  * The current date.
6178
6421
  */
@@ -9431,6 +9674,15 @@ declare class MsaEnumDisplayComponent {
9431
9674
  static ɵcmp: i0.ɵɵComponentDeclaration<MsaEnumDisplayComponent, "msa-enum-display", never, { "value": { "alias": "value"; "required": false; "isSignal": true; }; "enumType": { "alias": "enumType"; "required": false; "isSignal": true; }; "metadata": { "alias": "metadata"; "required": false; "isSignal": true; }; "showIcon": { "alias": "showIcon"; "required": false; "isSignal": true; }; "entity": { "alias": "entity"; "required": false; "isSignal": true; }; "context": { "alias": "context"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>;
9432
9675
  }
9433
9676
 
9677
+ declare class MsaSelectionLabelComponent {
9678
+ /**
9679
+ * Label value used by the i18n select expression.
9680
+ */
9681
+ label: any;
9682
+ static ɵfac: i0.ɵɵFactoryDeclaration<MsaSelectionLabelComponent, never>;
9683
+ static ɵcmp: i0.ɵɵComponentDeclaration<MsaSelectionLabelComponent, "msa-selection-label", never, { "label": { "alias": "label"; "required": false; }; }, {}, never, never, true, never>;
9684
+ }
9685
+
9434
9686
  declare const headerMetadataKey = "customer:vdHeader";
9435
9687
  declare const endpointMetadataKey = "customer:vdEndpoint";
9436
9688
 
@@ -11556,7 +11808,7 @@ declare class MatSelectRequiredDirective implements DoCheck {
11556
11808
  static ɵdir: i0.ɵɵDirectiveDeclaration<MatSelectRequiredDirective, "mat-select[formControl]:not([required]), mat-select[formControlName]:not([required])", never, {}, {}, never, never, true, never>;
11557
11809
  }
11558
11810
 
11559
- declare abstract class AbstractSelectFormField<T> extends AbstractMatFormField<T> implements OnInit {
11811
+ declare abstract class AbstractSelectFormField<T> extends AbstractMatFormField<T> implements OnInit, OnDestroy {
11560
11812
  /**
11561
11813
  * @property _endpointChange
11562
11814
  * @description A BehaviorSubject that tracks changes to the endpoint data.
@@ -11569,6 +11821,12 @@ declare abstract class AbstractSelectFormField<T> extends AbstractMatFormField<T
11569
11821
  * @type {BehaviorSubject<any[]>}
11570
11822
  */
11571
11823
  private _enumChange;
11824
+ /**
11825
+ * @property destroy$
11826
+ * @description Subject used to dispose subscriptions when the component is destroyed.
11827
+ * @type {Subject<void>}
11828
+ */
11829
+ private readonly destroy$;
11572
11830
  /**
11573
11831
  * @property _http
11574
11832
  * @description The HTTP client service used to fetch data from an API.
@@ -11596,9 +11854,9 @@ declare abstract class AbstractSelectFormField<T> extends AbstractMatFormField<T
11596
11854
  /**
11597
11855
  * @property _endpoint
11598
11856
  * @description The API endpoint or a function returning the endpoint URL.
11599
- * @type {string | Function | undefined}
11857
+ * @type {string | URL | Function | undefined}
11600
11858
  */
11601
- protected _endpoint?: string | Function;
11859
+ protected _endpoint?: string | URL | Function;
11602
11860
  /**
11603
11861
  * @property _params
11604
11862
  * @description Parameters to be sent with the API request.
@@ -11623,6 +11881,12 @@ declare abstract class AbstractSelectFormField<T> extends AbstractMatFormField<T
11623
11881
  * @type {Function | undefined}
11624
11882
  */
11625
11883
  protected _enumFilter?: Function;
11884
+ /**
11885
+ * @property _default
11886
+ * @description A predicate that identifies default option(s) after options are loaded.
11887
+ * @type {((x: any) => boolean) | undefined}
11888
+ */
11889
+ protected _default?: (x: any) => boolean;
11626
11890
  /**
11627
11891
  * @property _compareWith
11628
11892
  * @description A function to compare option values with the selected values.
@@ -11763,10 +12027,10 @@ declare abstract class AbstractSelectFormField<T> extends AbstractMatFormField<T
11763
12027
  /**
11764
12028
  * @property endpoint
11765
12029
  * @description The API endpoint or a function returning the endpoint URL.
11766
- * @type {string | Function | undefined}
12030
+ * @type {string | URL | Function | undefined}
11767
12031
  */
11768
- get endpoint(): string | Function | undefined;
11769
- set endpoint(endpoint: string | Function);
12032
+ get endpoint(): string | URL | Function | undefined;
12033
+ set endpoint(endpoint: string | URL | Function);
11770
12034
  /**
11771
12035
  * @property params
11772
12036
  * @description Parameters to be sent with the API request.
@@ -11795,6 +12059,13 @@ declare abstract class AbstractSelectFormField<T> extends AbstractMatFormField<T
11795
12059
  */
11796
12060
  get enumFilter(): Function | undefined;
11797
12061
  set enumFilter(enumFilter: Function);
12062
+ /**
12063
+ * @property default
12064
+ * @description A predicate used to select default option(s) from loaded options.
12065
+ * @type {((x: any) => boolean) | undefined}
12066
+ */
12067
+ get default(): ((x: any) => boolean) | undefined;
12068
+ set default(defaultFn: ((x: any) => boolean) | undefined);
11798
12069
  /**
11799
12070
  * @property disabled
11800
12071
  * @description Whether the control is disabled.
@@ -11863,10 +12134,15 @@ declare abstract class AbstractSelectFormField<T> extends AbstractMatFormField<T
11863
12134
  */
11864
12135
  constructor(controlType: string);
11865
12136
  /**
11866
- * Lifecycle hook that is called after a component's
11867
- * view has been fully initialized.
12137
+ * @description Initializes option sources and runtime subscriptions.
12138
+ * For enum-driven controls, metadata is recalculated on parent form changes
12139
+ * so hide and disable callbacks always use the latest form state.
11868
12140
  */
11869
12141
  ngOnInit(): void;
12142
+ /**
12143
+ * Disposes runtime subscriptions and delegates common form-field cleanup.
12144
+ */
12145
+ ngOnDestroy(): void;
11870
12146
  /**
11871
12147
  * From ControlValueAccessor interface
11872
12148
  * @param value
@@ -11897,6 +12173,17 @@ declare abstract class AbstractSelectFormField<T> extends AbstractMatFormField<T
11897
12173
  * @returns An array of filtered options that match the given value.
11898
12174
  */
11899
12175
  protected filterValue(value: any): any[] | undefined;
12176
+ /**
12177
+ * @description Normalizes endpoint payloads to a safe array for template iteration.
12178
+ * @param source Raw payload from endpoint or mapper.
12179
+ * @returns {any[]} Iterable options array.
12180
+ */
12181
+ protected normalizeOptions(source: any): any[];
12182
+ /**
12183
+ * @description Applies default option selection when a default predicate is configured.
12184
+ * @returns {void}
12185
+ */
12186
+ protected applyDefaultSelection(): void;
11900
12187
  /**
11901
12188
  * Trigger endpoint changed
11902
12189
  */
@@ -11905,6 +12192,11 @@ declare abstract class AbstractSelectFormField<T> extends AbstractMatFormField<T
11905
12192
  * Trigger enum changed
11906
12193
  */
11907
12194
  protected enumChanged(): void;
12195
+ /**
12196
+ * @description Builds enum options from metadata and then applies runtime enum filters.
12197
+ * @returns {void}
12198
+ */
12199
+ protected rebuildEnumOptions(): void;
11908
12200
  /**
11909
12201
  * Log to console
11910
12202
  * @param message
@@ -11912,7 +12204,7 @@ declare abstract class AbstractSelectFormField<T> extends AbstractMatFormField<T
11912
12204
  */
11913
12205
  log(message: any, ...optionalParams: any[]): void;
11914
12206
  static ɵfac: i0.ɵɵFactoryDeclaration<AbstractSelectFormField<any>, never>;
11915
- static ɵdir: i0.ɵɵDirectiveDeclaration<AbstractSelectFormField<any>, never, never, { "enum": { "alias": "enum"; "required": false; }; "enumMetadata": { "alias": "enumMetadata"; "required": false; }; "textPrefix": { "alias": "textPrefix"; "required": false; }; "optionTextProperty": { "alias": "optionTextProperty"; "required": false; }; "optionValueProperty": { "alias": "optionValueProperty"; "required": false; }; "matIconKey": { "alias": "matIconKey"; "required": false; }; "svgIconKey": { "alias": "svgIconKey"; "required": false; }; "fontSet": { "alias": "fontSet"; "required": false; }; "prefix": { "alias": "prefix"; "required": false; }; "options": { "alias": "options"; "required": false; }; "filteredOptions": { "alias": "filteredOptions"; "required": false; }; "filterable": { "alias": "filterable"; "required": false; }; "cache": { "alias": "cache"; "required": false; }; "selectFirst": { "alias": "selectFirst"; "required": false; }; "sortBy": { "alias": "sortBy"; "required": false; }; "mapper": { "alias": "mapper"; "required": false; }; "optionIcon": { "alias": "optionIcon"; "required": false; }; "defaultOption": { "alias": "defaultOption"; "required": false; }; "multiple": { "alias": "multiple"; "required": false; }; "sorted": { "alias": "sorted"; "required": false; }; "endpoint": { "alias": "endpoint"; "required": false; }; "params": { "alias": "params"; "required": false; }; "projection": { "alias": "projection"; "required": false; }; "loadData": { "alias": "loadData"; "required": false; }; "enumFilter": { "alias": "enumFilter"; "required": false; }; "disabled": { "alias": "disabled"; "required": false; }; "context": { "alias": "context"; "required": false; }; "compareWith": { "alias": "compareWith"; "required": false; }; "searchField": { "alias": "searchField"; "required": false; }; }, { "onValueChange": "change"; "onItemChange": "itemChange"; "onSelected": "selected"; "onItemSelected": "itemSelected"; "onLaunch": "launch"; }, never, never, true, never>;
12207
+ static ɵdir: i0.ɵɵDirectiveDeclaration<AbstractSelectFormField<any>, never, never, { "enum": { "alias": "enum"; "required": false; }; "enumMetadata": { "alias": "enumMetadata"; "required": false; }; "textPrefix": { "alias": "textPrefix"; "required": false; }; "optionTextProperty": { "alias": "optionTextProperty"; "required": false; }; "optionValueProperty": { "alias": "optionValueProperty"; "required": false; }; "matIconKey": { "alias": "matIconKey"; "required": false; }; "svgIconKey": { "alias": "svgIconKey"; "required": false; }; "fontSet": { "alias": "fontSet"; "required": false; }; "prefix": { "alias": "prefix"; "required": false; }; "options": { "alias": "options"; "required": false; }; "filteredOptions": { "alias": "filteredOptions"; "required": false; }; "filterable": { "alias": "filterable"; "required": false; }; "cache": { "alias": "cache"; "required": false; }; "selectFirst": { "alias": "selectFirst"; "required": false; }; "sortBy": { "alias": "sortBy"; "required": false; }; "mapper": { "alias": "mapper"; "required": false; }; "optionIcon": { "alias": "optionIcon"; "required": false; }; "defaultOption": { "alias": "defaultOption"; "required": false; }; "multiple": { "alias": "multiple"; "required": false; }; "sorted": { "alias": "sorted"; "required": false; }; "endpoint": { "alias": "endpoint"; "required": false; }; "params": { "alias": "params"; "required": false; }; "projection": { "alias": "projection"; "required": false; }; "loadData": { "alias": "loadData"; "required": false; }; "enumFilter": { "alias": "enumFilter"; "required": false; }; "default": { "alias": "default"; "required": false; }; "disabled": { "alias": "disabled"; "required": false; }; "context": { "alias": "context"; "required": false; }; "compareWith": { "alias": "compareWith"; "required": false; }; "searchField": { "alias": "searchField"; "required": false; }; }, { "onValueChange": "change"; "onItemChange": "itemChange"; "onSelected": "selected"; "onItemSelected": "itemSelected"; "onLaunch": "launch"; }, never, never, true, never>;
11916
12208
  }
11917
12209
 
11918
12210
  /**
@@ -13671,55 +13963,85 @@ declare class MenuSettingsResolve {
13671
13963
  static ɵprov: i0.ɵɵInjectableDeclaration<MenuSettingsResolve>;
13672
13964
  }
13673
13965
 
13674
- declare class MenuItemService extends GenericService<MenuItem> {
13966
+ declare class MenuService extends GenericService<Menu> {
13675
13967
  /**
13676
13968
  * Constructor
13677
13969
  * @param _http
13678
13970
  */
13679
13971
  constructor();
13680
- static ɵfac: i0.ɵɵFactoryDeclaration<MenuItemService, never>;
13681
- static ɵprov: i0.ɵɵInjectableDeclaration<MenuItemService>;
13972
+ static ɵfac: i0.ɵɵFactoryDeclaration<MenuService, never>;
13973
+ static ɵprov: i0.ɵɵInjectableDeclaration<MenuService>;
13682
13974
  }
13683
13975
 
13684
- declare class MenuService extends GenericService<Menu> {
13976
+ declare class MenuItemService extends GenericService<MenuItem> {
13685
13977
  /**
13686
13978
  * Constructor
13687
13979
  * @param _http
13688
13980
  */
13689
13981
  constructor();
13690
- static ɵfac: i0.ɵɵFactoryDeclaration<MenuService, never>;
13691
- static ɵprov: i0.ɵɵInjectableDeclaration<MenuService>;
13982
+ static ɵfac: i0.ɵɵFactoryDeclaration<MenuItemService, never>;
13983
+ static ɵprov: i0.ɵɵInjectableDeclaration<MenuItemService>;
13692
13984
  }
13693
13985
 
13986
+ /**
13987
+ * Options for the MenuResolve service
13988
+ */
13989
+ interface MenuResolveOptions {
13990
+ /**
13991
+ * The scope of the menu to resolve. This is used to filter the menu items based on their scope.
13992
+ * @type {string}
13993
+ */
13994
+ scope?: string;
13995
+ /**
13996
+ * Includes for the menu resolve service. This is used to specify which related entities should be included in the menu items.
13997
+ * @type {string[]}
13998
+ */
13999
+ includes?: string[];
14000
+ /**
14001
+ * Whether the menu resolve service is enabled or not. If set to false, the service will not fetch the menu items.
14002
+ * @type {boolean}
14003
+ */
14004
+ enabled?: boolean;
14005
+ /**
14006
+ * Additional options for the menu resolve service
14007
+ * @type {any}
14008
+ */
14009
+ [key: string]: any;
14010
+ }
14011
+ /**
14012
+ * Injection token for the MenuResolveOptions
14013
+ */
14014
+ declare const MENU_RESOLVE_OPTIONS: InjectionToken<MenuResolveOptions>;
13694
14015
  /**
13695
14016
  * Menu resolve service
13696
14017
  */
13697
14018
  declare class MenuResolve {
13698
14019
  private menuService;
14020
+ private options?;
13699
14021
  /**
13700
14022
  * Constructor
13701
- * @param menuService
14023
+ * @param menuService The menu service
14024
+ * @param options The menu resolve options
13702
14025
  */
13703
- constructor(menuService: MenuService);
14026
+ constructor(menuService: MenuService, options?: MenuResolveOptions | undefined);
13704
14027
  /**
13705
14028
  * Resolves menu items
13706
- * @param route
14029
+ * @param route The activated route snapshot
14030
+ * @returns An observable of menu items
13707
14031
  */
13708
- resolve(route: ActivatedRouteSnapshot): Observable<Menu>;
13709
- static ɵfac: i0.ɵɵFactoryDeclaration<MenuResolve, never>;
14032
+ resolve(route: ActivatedRouteSnapshot): Observable<Menu[]>;
14033
+ static ɵfac: i0.ɵɵFactoryDeclaration<MenuResolve, [null, { optional: true; }]>;
13710
14034
  static ɵprov: i0.ɵɵInjectableDeclaration<MenuResolve>;
13711
14035
  }
13712
14036
  /**
13713
14037
  * Submenu resolve service
13714
14038
  */
13715
14039
  declare class SubMenuResolve {
13716
- private router;
13717
- private route3;
13718
- constructor(router: Router, route3: ActivatedRoute);
13719
14040
  /**
13720
- * Resolves menu items
13721
- * @param route
13722
- * @param state
14041
+ * Resolve method to get the submenu item based on the current route
14042
+ * @param route The activated route snapshot
14043
+ * @param state The router state snapshot
14044
+ * @returns The submenu item or undefined if not found
13723
14045
  */
13724
14046
  resolve(route: ActivatedRouteSnapshot, state: RouterStateSnapshot): MenuItem | undefined;
13725
14047
  static ɵfac: i0.ɵɵFactoryDeclaration<SubMenuResolve, never>;
@@ -14512,5 +14834,5 @@ declare class TableStaticDataSource<TEntity> extends MatTableDataSource<TEntity>
14512
14834
  getSelected: <TType>(key?: string) => TType[];
14513
14835
  }
14514
14836
 
14515
- export { AbstractMatFormField, AbstractSelectFormField, ActionItem, Api, ApiResponse, AppEvent, AppEventType, AppSetting, AppStorage, AsyncValidationDirective, AuditEntity, AuditUser, AuthHelper, AuthUser, AutofocusDirective, BaseComponent, BaseDirective, BaseEntity, BaseInterceptor, BaseService, BindPipe, CachingInterceptor, Column, ColumnObject, Common, CommonError, CommonHandlerContext, ConfirmExitGuard, ContextHelper, DIALOG_PROVIDER, DIALOG_PROVIDER_FACTORY, DataSourceFilterDirective, DataSourcePipe, DatePickerHeaderComponent, DisableControlDirective, Display, DisplayNameNumberProjection, DisplayNameProjection, DynamicBuilder, DynamicComponentCompiler, EXPORT_DIALOG_COMPONENT, EmptyStringResetDirective, EnumMetadata, EnumPipe, EnumService, EqualValidator, ErrorMessageBindingStrategy, EventQueueService, Facet, FacetValue, FieldFuncPipe, FileControlDirective, FileService, FileSizePipe, FilterClearComponent, FilterDateComponent, FilterGlue, FilterInputComponent, FilterOperator, FilterPipe, FilterSelectComponent, FirstLetterPipe, Form, FormArrayPipe, FormBuilderConfiguration, FormControlPipe, FormDefinition, FormField, FormFieldDefinition, FormFieldGroup, FormFieldGroupDefinition, FormFieldType, FormGroupPipe, FuncPipe, GenericEmbeddedListComponent, GenericFormBaseComponent, GenericFormComponent, GenericListComponent, GenericReactiveFormComponent, GenericService, GlobalRoles, Grid, GroupFilterPipe, HtmlControlTemplateDirective, IAbstractControl, Icon, ImageFileControlDirective, IpVersion, KeyValue, KeysPipe, LayoutToggle, LoadingScreenInterceptor, LoadingScreenService, MEDIA_PROVIDER, MEDIA_PROVIDER_FACTORY, MatFormFieldEditorDirective, MatFormFieldRadioDirective, MatFormFieldReadonlyDirective, MatInputRequiredDirective, MatSelectRequiredDirective, Menu, MenuClient, MenuDepartment, MenuFormIncludesResolve, MenuItem, MenuItemClient, MenuItemDepartment, MenuItemFormIncludesResolve, MenuItemService, MenuItemTarget, MenuListProjectionResolve, MenuResolve, MenuScope, MenuSettings, MenuSettingsResolve, MessageType, ModifiableEntity, MonthNamePipe, MsaEditFormActionsComponent, MsaEnumDisplayComponent, MsaSelectRequiredDirective, NameNumberProjection, NameProjection, NativeElementInjectorDirective, NumericValueType, OnlyNumberDirective, OrderPipe, Pagination, PaginatorIntl, ParseDecimalDirective, Permission, PlaceholderPipe, PrefixDirective, PrintService, PropertyJoinPipe, ReactiveFormConfig, ReactiveTypedFormsModule, RemoveWhitespaceDirective, ResetFormType, RxFormArray, RxFormBuilder, RxFormControl, RxFormControlDirective, RxFormGroup, RxReactiveFormsModule, RxwebFormDirective, RxwebValidators, SafeHtmlPipe, Salutation, SaveAction, SplitPipe, SubMenuResolve, SuffixButton, TABLE_COLUMNS_METADATA_KEY, TABLE_DEFINITION_METADATA_KEY, Table, TableColumn, TableColumnConfig, TableColumnType, TableConfig, TableDataSource, TableDefinition, TableQueryConfig, TableStaticDataSource, TaskDialogData, Templates, TimePipe, TitleCase, TitleProjection, TruncatePipe, TypedForm, TypedFormBuilder, UniqueValidatorDirective, UrlValidationType, Utils, ValidationAlphabetLocale, ValueAccessorBase, ValuesPipe, VdAlertDialogComponent, VdChipsComponent, VdCodeDirective, VdConfirmDialogComponent, VdCustomDirective, VdDelayedHoverDirective, VdDialogActionsDirective, VdDialogComponent, VdDialogContentDirective, VdDialogHeaderActionsComponent, VdDialogHeaderComponent, VdDialogMaximizeDirective, VdDialogService, VdDialogTitleDirective, VdDynamicMenuComponent, VdDynamicTableComponent, VdDynamicTableConfigDialogComponent, VdEditorDirective, VdFileDirective, VdFileInputComponent, VdFileModule, VdFilterOptionDirective, VdGenericFormComponent, VdGenericFormCustomFieldDirective, VdLayoutCardOverComponent, VdLayoutCloseDirective, VdLayoutCompactComponent, VdLayoutComponent, VdLayoutFooterComponent, VdLayoutManageListCloseDirective, VdLayoutManageListComponent, VdLayoutManageListOpenDirective, VdLayoutManageListToggleDirective, VdLayoutNavComponent, VdLayoutNavListCloseDirective, VdLayoutNavListComponent, VdLayoutNavListOpenDirective, VdLayoutNavListToggleDirective, VdLayoutOpenDirective, VdLayoutToggleDirective, VdListOptionDirective, VdListToolbarComponent, VdMediaService, VdMediaToggleDirective, VdMenuComponent, VdNavigationDrawerComponent, VdNavigationDrawerMenuDirective, VdNavigationDrawerToolbarDirective, VdPromptDialogComponent, VdSelectComponent, VdSelectOptionDirective, VdSelectTriggerDirective, VdTableFieldDirective, VdTaskDialogComponent, allOf, allOfAsync, alpha, alphaAsync, alphaNumeric, alphaNumericAsync, and, ascii, async, blacklist, choice, choiceAsync, compare, compose, contains, containsAsync, creditCard, creditCardAsync, cusip, custom, customAsync, dataUri, date, dateAsync, different, digit, disable, elementClass, email, endpointMetadataKey, endsWith, endsWithAsync, error, escape, even, extension, extensionAsync, factor, factorAsync, file, fileAsync, fileSize, fileSizeAsync, formDefinitionMetadataKey, formFieldGroupsMetadataKey, formFieldsMetadataKey, getDisplay, getEndpoint, getFormDefinition, getFormGroups, getTableDefinition, graphql, greaterThan, greaterThanAsync, greaterThanEqualTo, greaterThanEqualToAsync, grid, hasRequiredValidator, headerMetadataKey, hexColor, iban, ibanAsync, image, imageAsync, json, latLong, latitude, leapYear, lessThan, lessThanAsync, lessThanEqualTo, lessThanEqualToAsync, longitude, lowerCase, ltrim, mac, mask, maxDate, maxDateAsync, maxLength, maxLengthAsync, maxNumber, maxNumberAsync, maxTime, maxTimeAsync, minDate, minDateAsync, minLength, minLengthAsync, minNumber, minNumberAsync, minTime, minTimeAsync, mixinDisableRipple, mixinDisabled, model, noneOf, noneOfAsync, not, notEmpty, numeric, numericAsync, odd, oneOf, oneOfAsync, or, parseProjectionArray, parseProjectionString, password, passwordAsync, pattern, patternAsync, port, prefix, primeNumber, prop, propArray, propObject, range, rangeAsync, required, requiredTrue, rtrim, rule, sanitize, startsWith, startsWithAsync, stripLow, suffix, time, timeAsync, toBoolean, toDate, toDouble, toFloat, toInt, toString, trim, unique, updateOn, upperCase, url, urlAsync, whitelist };
14516
- export type { AppFormGroup, CanComponentDeactivate, Constructor$1 as Constructor, Delegate, DialogButtonConfig, EditorChange, EnumItem, Filter, FilterField, FormGroupExtension, IAlertConfig, IBaseComponent, ICanDisable, ICanDisableRipple, ICommonHandlerContext, IConfirmConfig, IDialogConfig, IEntity, IFormGroup, IGenericFormBaseComponent, IGenericListComponent, IGenericReactiveFormBaseComponent, ILayoutTogglable, IPromptConfig, Options, ShowConfirmationDialog, ShowTaskDialog, VdGenericFormInitEvent };
14837
+ export { AbstractMatFormField, AbstractSelectFormField, ActionItem, Api, ApiResponse, AppEvent, AppEventType, AppSetting, AppStorage, AsyncValidationDirective, AuditEntity, AuditUser, AuthHelper, AuthUser, AutofocusDirective, BaseComponent, BaseDirective, BaseEntity, BaseInterceptor, BaseService, BindPipe, CachingInterceptor, Column, ColumnObject, Common, CommonError, CommonHandlerContext, ConfirmExitGuard, ContextHelper, DIALOG_PROVIDER, DIALOG_PROVIDER_FACTORY, DataSourceFilterDirective, DataSourcePipe, DatePickerHeaderComponent, DisableControlDirective, Display, DisplayNameNumberProjection, DisplayNameProjection, DynamicBuilder, DynamicComponentCompiler, EXPORT_DIALOG_COMPONENT, EmptyStringResetDirective, EnumMetadata, EnumPipe, EnumService, EqualValidator, ErrorMessageBindingStrategy, EventQueueService, Facet, FacetValue, FieldFuncPipe, FileControlDirective, FileService, FileSizePipe, FilterClearComponent, FilterDateComponent, FilterGlue, FilterInputComponent, FilterOperator, FilterPipe, FilterSelectComponent, FirstLetterPipe, Form, FormArrayPipe, FormBuilderConfiguration, FormControlPipe, FormDefinition, FormField, FormFieldDefinition, FormFieldGroup, FormFieldGroupDefinition, FormFieldType, FormGroupPipe, FuncPipe, GenericEmbeddedListComponent, GenericFormBaseComponent, GenericFormComponent, GenericListComponent, GenericReactiveFormComponent, GenericService, GlobalRoles, Grid, GroupFilterPipe, HtmlControlTemplateDirective, IAbstractControl, Icon, ImageFileControlDirective, IpVersion, KeyValue, KeysPipe, LayoutToggle, LoadingScreenInterceptor, LoadingScreenService, MEDIA_PROVIDER, MEDIA_PROVIDER_FACTORY, MENU_RESOLVE_OPTIONS, MatFormFieldEditorDirective, MatFormFieldRadioDirective, MatFormFieldReadonlyDirective, MatInputRequiredDirective, MatSelectRequiredDirective, Menu, MenuClient, MenuDepartment, MenuFormIncludesResolve, MenuItem, MenuItemClient, MenuItemDepartment, MenuItemFormIncludesResolve, MenuItemService, MenuItemTarget, MenuListProjectionResolve, MenuResolve, MenuScope, MenuService, MenuSettings, MenuSettingsResolve, MessageType, ModifiableEntity, MonthNamePipe, MsaEditFormActionsComponent, MsaEnumDisplayComponent, MsaSelectRequiredDirective, MsaSelectionLabelComponent, NameNumberProjection, NameProjection, NativeElementInjectorDirective, NumericValueType, OnlyNumberDirective, OrderPipe, Pagination, PaginatorIntl, ParseDecimalDirective, Permission, PlaceholderPipe, PrefixDirective, PrintService, PropertyJoinPipe, ReactiveFormConfig, ReactiveTypedFormsModule, RemoveWhitespaceDirective, ResetFormType, RxFormArray, RxFormBuilder, RxFormControl, RxFormControlDirective, RxFormGroup, RxReactiveFormsModule, RxwebFormDirective, RxwebValidators, SafeHtmlPipe, Salutation, SaveAction, SplitPipe, SubMenuResolve, SuffixButton, TABLE_COLUMNS_METADATA_KEY, TABLE_DEFINITION_METADATA_KEY, Table, TableColumn, TableColumnConfig, TableColumnType, TableConfig, TableDataSource, TableDefinition, TableQueryConfig, TableStaticDataSource, TaskDialogData, Templates, TimePipe, TitleCase, TitleProjection, TruncatePipe, TypedForm, TypedFormBuilder, UniqueValidatorDirective, UrlValidationType, Utils, ValidationAlphabetLocale, ValueAccessorBase, ValuesPipe, VdAlertDialogComponent, VdChipsComponent, VdCodeDirective, VdConfirmDialogComponent, VdCustomDirective, VdDelayedHoverDirective, VdDialogActionsDirective, VdDialogComponent, VdDialogContentDirective, VdDialogHeaderActionsComponent, VdDialogHeaderComponent, VdDialogMaximizeDirective, VdDialogService, VdDialogTitleDirective, VdDynamicMenuComponent, VdDynamicTableComponent, VdDynamicTableConfigDialogComponent, VdEditorDirective, VdFileDirective, VdFileInputComponent, VdFileModule, VdFilterOptionDirective, VdGenericFormComponent, VdGenericFormCustomFieldDirective, VdLayoutCardOverComponent, VdLayoutCloseDirective, VdLayoutCompactComponent, VdLayoutComponent, VdLayoutFooterComponent, VdLayoutManageListCloseDirective, VdLayoutManageListComponent, VdLayoutManageListOpenDirective, VdLayoutManageListToggleDirective, VdLayoutNavComponent, VdLayoutNavListCloseDirective, VdLayoutNavListComponent, VdLayoutNavListOpenDirective, VdLayoutNavListToggleDirective, VdLayoutOpenDirective, VdLayoutToggleDirective, VdListOptionDirective, VdListToolbarComponent, VdMediaService, VdMediaToggleDirective, VdMenuComponent, VdNavigationDrawerComponent, VdNavigationDrawerMenuDirective, VdNavigationDrawerToolbarDirective, VdPromptDialogComponent, VdSelectComponent, VdSelectOptionDirective, VdSelectTriggerDirective, VdTableFieldDirective, VdTaskDialogComponent, allOf, allOfAsync, alpha, alphaAsync, alphaNumeric, alphaNumericAsync, and, ascii, async, blacklist, choice, choiceAsync, compare, compose, contains, containsAsync, creditCard, creditCardAsync, cusip, custom, customAsync, dataUri, date, dateAsync, different, digit, disable, elementClass, email, endpointMetadataKey, endsWith, endsWithAsync, error, escape, even, extension, extensionAsync, factor, factorAsync, file, fileAsync, fileSize, fileSizeAsync, formDefinitionMetadataKey, formFieldGroupsMetadataKey, formFieldsMetadataKey, getDisplay, getEndpoint, getFormDefinition, getFormGroups, getTableDefinition, graphql, greaterThan, greaterThanAsync, greaterThanEqualTo, greaterThanEqualToAsync, grid, hasRequiredValidator, headerMetadataKey, hexColor, iban, ibanAsync, image, imageAsync, json, latLong, latitude, leapYear, lessThan, lessThanAsync, lessThanEqualTo, lessThanEqualToAsync, longitude, lowerCase, ltrim, mac, mask, maxDate, maxDateAsync, maxLength, maxLengthAsync, maxNumber, maxNumberAsync, maxTime, maxTimeAsync, minDate, minDateAsync, minLength, minLengthAsync, minNumber, minNumberAsync, minTime, minTimeAsync, mixinDisableRipple, mixinDisabled, model, noneOf, noneOfAsync, not, notEmpty, numeric, numericAsync, odd, oneOf, oneOfAsync, or, parseProjectionArray, parseProjectionString, password, passwordAsync, pattern, patternAsync, port, prefix, primeNumber, prop, propArray, propObject, range, rangeAsync, required, requiredTrue, rtrim, rule, sanitize, startsWith, startsWithAsync, stripLow, suffix, time, timeAsync, toBoolean, toDate, toDouble, toFloat, toInt, toString, trim, unique, updateOn, upperCase, url, urlAsync, whitelist };
14838
+ export type { AppFormGroup, CanComponentDeactivate, Constructor$1 as Constructor, Delegate, DialogButtonConfig, EditorChange, EnumItem, Filter, FilterField, FormGroupExtension, IAlertConfig, IBaseComponent, ICanDisable, ICanDisableRipple, ICommonHandlerContext, IConfirmConfig, IDialogConfig, IEntity, IFormGroup, IGenericFormBaseComponent, IGenericListComponent, IGenericReactiveFormBaseComponent, ILayoutTogglable, IPromptConfig, MenuResolveOptions, Options, ShowConfirmationDialog, ShowTaskDialog, VdGenericFormInitEvent };