@eternalcodestudio/primeng-table 19.0.0 → 20.0.0

package/index.d.ts

@@ -1,5 +1,453 @@
+import * as i0 from '@angular/core';
+import { OnInit, AfterViewInit, OnDestroy, EventEmitter, ElementRef } from '@angular/core';
+import { Table, TableLazyLoadEvent, TableRowSelectEvent, TableRowUnSelectEvent, TablePageEvent } from 'primeng/table';
+import { SortMeta, MenuItem } from 'primeng/api';
+import { Observable } from 'rxjs';
+import { HttpHeaders, HttpResponse } from '@angular/common/http';
+
+declare abstract class ECSPrimengTableHttpService {
+    abstract handleHttpGetRequest<T>(servicePoint: string, httpOptions?: HttpHeaders | null, showSpinner?: boolean, customErrorHandler?: ((error: any) => Observable<any>) | null, showAPIError?: boolean, responseType?: 'json' | 'blob'): Observable<HttpResponse<T>>;
+    abstract handleHttpPostRequest<T>(servicePoint: string, data: any, httpOptions?: HttpHeaders | null, showSpinner?: boolean, customErrorHandler?: ((error: any) => Observable<any>) | null, showAPIError?: boolean, responseType?: 'json' | 'blob'): Observable<HttpResponse<T>>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<ECSPrimengTableHttpService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<ECSPrimengTableHttpService>;
+}
+
+declare abstract class ECSPrimengTableNotificationService {
+    abstract showToast(severity: string, title: string, message: string, duration?: number, keepToast?: boolean, closable?: boolean, clearPrevious?: boolean): void;
+    abstract clearToasts(): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<ECSPrimengTableNotificationService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<ECSPrimengTableNotificationService>;
+}
+
 /**
- * Generated bundle index. Do not edit.
+ * Interface representing the configuration for action buttons in a PrimeNG table.
  */
-/// <amd-module name="@eternalcodestudio/primeng-table" />
-export * from './public-api';
+interface ITableButton {
+    /**
+     * Gets or sets the icon to be displayed on the button.
+     * The value should be a string representing the PrimeIcons class name.
+     */
+    icon?: string;
+    label?: string;
+    /**
+     * Gets or sets the color style class to be applied to the button.
+     * The value should be a string representing a CSS class for styling the button.
+     */
+    color?: string;
+    /**
+     * Gets or sets the condition for displaying the button.
+     * It is a function that takes row data as input and returns a boolean indicating
+     * whether the button should be displayed for that row.
+     */
+    condition?: (rowData: any) => boolean;
+    /**
+     * Represents the action to be executed when the button is clicked.
+     * This function takes the row data of the clicked row as input and performs
+     * specific actions based on that data.
+     */
+    action?: (rowData: any) => void;
+    tooltip?: string;
+}
+
+/**
+ * Interface representing the request structure for PrimeNG post requests.
+ */
+interface ITableQueryRequest {
+    /** Gets or sets the current page number.*/
+    page: number;
+    /** Gets or sets the number of items to display per page.*/
+    pageSize: number;
+    /** Gets or sets a list of sorting configurations for the table.*/
+    sort?: any;
+    /** Gets or sets a dictionary containing filter configurations for each column.*/
+    filter: any;
+    /** Gets or sets a global filter string applied to all columns.*/
+    globalFilter?: string | null;
+    /** Gets or sets a list of columns to be included in the response.*/
+    columns?: string[];
+    dateFormat: string;
+    dateTimezone: string;
+    dateCulture: string;
+}
+
+interface IExcelExportRequest extends ITableQueryRequest {
+    filename: string;
+    allColumns: boolean;
+    applyFilters: boolean;
+    applySorts: boolean;
+}
+
+declare enum CellOverflowBehaviour {
+    Hidden = 0,
+    Wrap = 1
+}
+
+declare enum DataAlignHorizontal {
+    Left = 0,
+    Center = 1,
+    Right = 2
+}
+
+declare enum DataAlignVertical {
+    Top = 0,
+    Middle = 1,
+    Bottom = 2
+}
+
+declare enum DataType {
+    Text = 0,
+    Numeric = 1,
+    Boolean = 2,
+    Date = 3
+}
+
+declare enum FrozenColumnAlign {
+    Noone = 0,
+    Left = 1,
+    Right = 2
+}
+
+declare enum TableViewSaveMode {
+    noone = 0,
+    sessionStorage = 1,
+    localStorage = 2,
+    databaseStorage = 3
+}
+
+interface IColumnMetadata {
+    field: string;
+    header: string;
+    dataType: DataType;
+    dataAlignHorizontal: DataAlignHorizontal;
+    dataAlignHorizontalAllowUserEdit: boolean;
+    dataAlignVertical: DataAlignVertical;
+    dataAlignVerticalAllowUserEdit: boolean;
+    canBeHidden: boolean;
+    startHidden: boolean;
+    canBeResized: boolean;
+    canBeReordered: boolean;
+    canBeSorted: boolean;
+    canBeFiltered: boolean;
+    filterPredifinedValuesName: string;
+    canBeGlobalFiltered: boolean;
+    columnDescription: string;
+    dataTooltipShow: boolean;
+    dataTooltipCustomColumnSource: string;
+    frozenColumnAlign: FrozenColumnAlign;
+    cellOverflowBehaviour: CellOverflowBehaviour;
+    cellOverflowBehaviourAllowUserEdit: boolean;
+    initialWidth: number;
+}
+
+interface IPredifinedFilter {
+    /**
+     * The value of the PrimeNG icon.
+     */
+    icon?: string;
+    iconURL?: string;
+    iconBlobSourceEndpoint?: string;
+    iconBlobSourceEndpointResponseError?: boolean;
+    /**
+     * The icon as a blob.
+     */
+    iconBlob?: Blob;
+    /**
+     * A string representing the name to be shown in the UI.
+     */
+    name?: string;
+    /**
+     * If the name needs to be shown in the UI
+     */
+    displayName?: boolean;
+    /**
+     * The underlying value of the option. The value can be of any type and represents the data managed behind the scenes.
+     */
+    value: any;
+    /**
+     * If the value needs to be displayed with a tag
+     */
+    displayTag?: boolean;
+    tagStyle?: {
+        [key: string]: string;
+    };
+    iconColor?: string;
+    iconStyle?: string;
+}
+
+interface ITableConfiguration {
+    columnsInfo: IColumnMetadata[];
+    allowedItemsPerPage: number[];
+    dateFormat: string;
+    dateTimezone: string;
+    dateCulture: string;
+}
+
+/**
+ * Interface representing the return structure for PrimeNG post requests when gathering data to represent in a table.
+ */
+interface ITablePagedResponse {
+    /** The current page number.*/
+    page: number;
+    /** Total number of records available from filter.*/
+    totalRecords: number;
+    /** Total number of records available (without filters).*/
+    totalRecordsNotFiltered: number;
+    /** Dynamic data representing the response content of data for the table.*/
+    data: any;
+}
+
+interface ITableViewData {
+    columnsShown: IColumnMetadata[];
+    tableWidth: any;
+    columnsWidth: string;
+    multiSortMeta: SortMeta[] | null | undefined;
+    filters: any;
+    globalSearchText: string | null;
+    currentPage: number;
+    currentRowsPerPage: number;
+}
+
+interface ITableView {
+    lastActive: boolean;
+    viewAlias: string;
+    viewData: ITableViewData;
+}
+
+declare class ECSPrimengTableService {
+    private http;
+    private notification;
+    constructor(http: ECSPrimengTableHttpService, notification: ECSPrimengTableNotificationService);
+    fetchTableConfiguration(url: string): Observable<HttpResponse<ITableConfiguration>>;
+    fetchTableData(url: string, postData: ITableQueryRequest): Observable<HttpResponse<ITablePagedResponse>>;
+    fetchExcelReport(url: string, postData: IExcelExportRequest): Observable<HttpResponse<Blob>>;
+    downloadFile(data: Blob, fileName: string, contentType: string): void;
+    handleTableError(error: any, customTitle?: string): void;
+    orderColumnsWithFrozens(colsToOrder: IColumnMetadata[]): IColumnMetadata[];
+    /**
+     * Handles click events on action buttons in a row of data.
+     *
+     * @param {function} action - The action function to be executed when the button is clicked. It should accept one parameter, which is the row data.
+     * @param {any} [rowData=null] - The data of the row corresponding to the clicked button. Defaults to null.
+     *
+     * @returns {void}
+     *
+     * @example
+     * // Define an action for a button
+     * const deleteAction = (rowData) => {
+     *   console.log(`Delete row with id: ${rowData.rowID}`);
+     * };
+     *
+     * // Use handleButtonsClick with row data
+     * handleButtonsClick(deleteAction, { rowID: 1, name: 'John Doe' });
+     */
+    handleButtonsClick(action: (rowData: any) => void, rowData?: any): void;
+    getColumnStyle(col: any, headerCols?: boolean): Record<string, string>;
+    fetchTableViews(tableViewSaveAs: TableViewSaveMode, recoverListEndpoint: string, tableViewSaveKey: string): ITableView[] | Observable<HttpResponse<ITableView[]>>;
+    sortViews(tableSaveViewList: ITableView[]): void;
+    updateViewsMenuItems(tableSaveViewList: ITableView[]): MenuItem[];
+    viewsSaveToDatabase(tableSaveViewList: ITableView[], setListEndpoint: string, tableViewSaveKey: string): Observable<HttpResponse<any>>;
+    viewGenerateData(dt: Table, globalSearchText: string | null, currentPage: number, currentRowsPerPage: number, modifyFiltersFn: (filters: any) => any): ITableViewData;
+    computeColumnWidths(dt: Table): any;
+    computeTableWidth(dt: Table): any;
+    static ɵfac: i0.ɵɵFactoryDeclaration<ECSPrimengTableService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<ECSPrimengTableService>;
+}
+
+declare class ECSPrimengTable implements OnInit, AfterViewInit, OnDestroy {
+    private tableService;
+    private notification;
+    private resizeObserver;
+    constructor(tableService: ECSPrimengTableService, notification: ECSPrimengTableNotificationService);
+    isActive: boolean;
+    data: any[];
+    columnsToShow: IColumnMetadata[];
+    computeScrollHeight: boolean;
+    globalSearchEnabled: boolean;
+    globalSearchMaxLength: number;
+    globalSearchPlaceholder: string;
+    columnEditorEnabled: boolean;
+    urlColumnsSource: string;
+    urlDataSource: string;
+    urlExcelReport: string | null;
+    predifinedFiltersCollection: {
+        [key: string]: IPredifinedFilter[];
+    };
+    predifinedFiltersNoSelectionPlaceholder: string;
+    predifinedFiltersCollectionSelectedValuesText: string;
+    rowActionButtons: ITableButton[];
+    headerActionButtons: ITableButton[];
+    copyCellDataToClipboardTimeSecs: number;
+    actionsColumnAligmentRight: boolean;
+    actionsColumnWidth: number;
+    actionsColumnFrozen: boolean;
+    rowSelectorColumnActive: boolean;
+    rowSelectorColumName: string;
+    rowSelectorColumnAligmentRight: boolean;
+    rowSelectorColumnWidth: number;
+    rowSelectorColumnFrozen: boolean;
+    actionsColumnResizable: boolean;
+    actionColumnName: string;
+    rowselectorColumnResizable: boolean;
+    noDataFoundText: string;
+    showClearSortAndFilters: boolean;
+    excelReportTitleDefault: string;
+    excelReportTitleAllowUserEdit: boolean;
+    tableViewSaveAs: TableViewSaveMode;
+    tableViewSaveKey: string;
+    viewsGetSourceURL: string;
+    viewsSaveSourceURL: string;
+    maxTableViews: number;
+    onRowCheckboxChange: EventEmitter<{
+        rowID: any;
+        selected: boolean;
+    }>;
+    onRowSelect: EventEmitter<{
+        rowID: any;
+        rowData: any;
+    }>;
+    onRowUnselect: EventEmitter<{
+        rowID: any;
+        rowData: any;
+    }>;
+    viewsModalShow: boolean;
+    tableViewCurrentSelectedAlias: string | null;
+    tableViewsFirstFetchDone: boolean;
+    excelReportTitle: string;
+    showExportModal: boolean;
+    showColumnSelector: boolean;
+    selectedRowsCheckbox: any[];
+    dt: Table;
+    showRefreshData: boolean;
+    scrollHeight: string;
+    globalSearchText: string | null;
+    tableViewsList: ITableView[];
+    tableViews_menuItems: MenuItem[];
+    DataType: typeof DataType;
+    CellOverflowBehaviour: typeof CellOverflowBehaviour;
+    DataAlignHorizontal: typeof DataAlignHorizontal;
+    DataAlignVertical: typeof DataAlignVertical;
+    FrozenColumnAlign: typeof FrozenColumnAlign;
+    TableViewSaveMode: typeof TableViewSaveMode;
+    rowSelection: any;
+    currentPage: number;
+    currentRowsPerPage: number;
+    allowedRowsPerPage: number[];
+    totalRecords: number;
+    totalRecordsNotFiltered: number;
+    dateFormat: string;
+    dateTimezone: string;
+    dateCulture: string;
+    columns: IColumnMetadata[];
+    columnsCantBeHidden: IColumnMetadata[];
+    columnsSelected: IColumnMetadata[];
+    columnModalData: any[];
+    filteredColumnData: any[];
+    predifinedFiltersSelectedValuesCollection: {
+        [key: string]: any[];
+    };
+    private copyCellDataTimer;
+    tableLazyLoadEventInformation: TableLazyLoadEvent;
+    private initialConfigurationFetched;
+    ngOnInit(): void;
+    tableContainer: ElementRef;
+    headerContainer: ElementRef;
+    paginatorContainer: ElementRef;
+    ngAfterViewInit(): void;
+    onWindowResize: () => void;
+    calculateScrollHeight(): void;
+    ngOnDestroy(): void;
+    /**
+     * Used to update the data of a table externally outside the component. Use this method instead of 'updateData' to force the data updata of a table
+     *
+     * @param {(optionalData?: any) => void} [continueAction] - Optional action to execute after data retrieval if it succeeded.
+     * @param {boolean} [uponContinueActionEndModalHttp=false] - Optional flag to set the loading indicator to inactive after data retrieval.
+     */
+    updateData(continueAction?: (optionalData?: any) => void, uponContinueActionEndModalHttp?: boolean): void;
+    fetchTableConfiguration(): void;
+    private handleTableConfigurationResponse;
+    refreshData(event: any): void;
+    tableViewsEnabled(): boolean;
+    fetchTableViews(): void;
+    private tableViewListProcess;
+    viewLoad(tableViewAlias: string): void;
+    viewCreate(viewAlias: string): void;
+    viewDelete(viewAlias: string): void;
+    viewEditAlias(event: {
+        viewAliasOld: string;
+        viewAliasNew: string;
+    }): void;
+    viewUpdateData(viewAlias: string): void;
+    viewsSave(endMessage: number): void;
+    viewsSaveEnd(endMessage: number): void;
+    fetchTableData(event: TableLazyLoadEvent): void;
+    private modifyFiltersWithoutGlobalAndSelectedRows;
+    private selectorRowFilterBuilder;
+    revertDateTimeZoneFilters(inputFilter: any): any;
+    handleTableDataResponse(body: ITablePagedResponse): void;
+    clearFilters(dt: Table, force?: boolean, onlyGlobalFilter?: boolean): void;
+    clearSorts(dt: Table, force?: boolean): void;
+    hasToClearSorts(dt: Table, force?: boolean): boolean;
+    hasToClearFilters(dt: Table, globalSearchText: string | null, force?: boolean): boolean;
+    /**
+     * Determines whether there are active filters based on the provided filter rules.
+     *
+     * @param {any} filterRules An object representing filter rules for each column.
+     *   The keys are column names, and the values are arrays of filter rules.
+     *   Each filter rule has the following properties:
+     *     - `field`: The field or property name of the column.
+     *     - `value`: The filter value entered by the user.
+     *     - Other properties depending on the type of filter (e.g., `matchMode` for string filters).
+     * @returns {boolean} `true` if at least one active filter is found, otherwise `false`.
+     */
+    private hasFilters;
+    getColumnStyle(col: any, headerCols?: boolean): Record<string, string>;
+    getPredifinedFilterValues(columnKeyName: string): IPredifinedFilter[];
+    getFrozenColumnAlignAsText(frozenColumnAlign: FrozenColumnAlign): string;
+    getDataTypeAsText(dataType: DataType): string;
+    /**
+     * Updates the filters of a PrimeNG data table based on predefined filter changes.
+     *
+     * @param {string} filterName - The name of the filter to be updated.
+     * @param {IPrimengPredifinedFilter[]} selectedValues - An array of selected predefined filter values.
+     */
+    onPredifinedFilterChange(filterName: string, selectedValues: IPredifinedFilter[]): void;
+    /**
+     * Retrieves the number of values selected for a predefined filter.
+     *
+     * This function checks the collection of selected values for a specified column key name and returns a string
+     * indicating the number of selected items along with a predefined text.
+     *
+     * @param {string} columnKeyName - The key name of the column for which to retrieve the number of selected values.
+     * @returns {string} A string indicating the number of selected values for the specified column.
+     */
+    predifinedFiltersSelectedValuesText(columnKeyName: string): string;
+    handleButtonsClick(action: (rowData: any) => void, rowData?: any): void;
+    /**
+     * Checks if the provided column metadata matches a specific style of the predefined filters
+     * that need to be applied to an item on a row.
+     *
+     * @param {IprimengColumnsMetadata} colMetadata - The metadata of the column being checked.
+     * @param {any} value - The value to be matched against the predefined filter values.
+     * @returns {any} The matching predefined filter value if found, otherwise null.
+     */
+    getPredfinedFilterMatch(colMetadata: IColumnMetadata, value: any): any;
+    copyToClipboardStart(event: MouseEvent): void;
+    copyToClipboardCancel(): void;
+    getDataAlignHorizontalAsText(dataAlignHorizontal: DataAlignHorizontal): string;
+    getDataAlignVerticalAsText(dataAlignVertical: DataAlignVertical): string;
+    isRowCheckboxSelected(rowID: any): boolean;
+    onRowChekboxChange(event: any, rowID: any): void;
+    rowSelect(event: TableRowSelectEvent<any>): void;
+    rowUnselect(event: TableRowUnSelectEvent<any>): void;
+    pageChange(event: TablePageEvent): void;
+    columnSelectorShow(): void;
+    applyColumnModalChanges(selectedColumns: IColumnMetadata[]): void;
+    private updateColumnsSpecialProperties;
+    openExcelExport(): void;
+    generateExcelReport(event: any): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<ECSPrimengTable, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<ECSPrimengTable, "ecs-primeng-table", never, { "isActive": { "alias": "isActive"; "required": false; }; "data": { "alias": "data"; "required": false; }; "columnsToShow": { "alias": "columnsToShow"; "required": false; }; "computeScrollHeight": { "alias": "computeScrollHeight"; "required": false; }; "globalSearchEnabled": { "alias": "globalSearchEnabled"; "required": false; }; "globalSearchMaxLength": { "alias": "globalSearchMaxLength"; "required": false; }; "globalSearchPlaceholder": { "alias": "globalSearchPlaceholder"; "required": false; }; "columnEditorEnabled": { "alias": "columnEditorEnabled"; "required": false; }; "urlColumnsSource": { "alias": "urlColumnsSource"; "required": false; }; "urlDataSource": { "alias": "urlDataSource"; "required": false; }; "urlExcelReport": { "alias": "urlExcelReport"; "required": false; }; "predifinedFiltersCollection": { "alias": "predifinedFiltersCollection"; "required": false; }; "predifinedFiltersNoSelectionPlaceholder": { "alias": "predifinedFiltersNoSelectionPlaceholder"; "required": false; }; "predifinedFiltersCollectionSelectedValuesText": { "alias": "predifinedFiltersCollectionSelectedValuesText"; "required": false; }; "rowActionButtons": { "alias": "rowActionButtons"; "required": false; }; "headerActionButtons": { "alias": "headerActionButtons"; "required": false; }; "copyCellDataToClipboardTimeSecs": { "alias": "copyCellDataToClipboardTimeSecs"; "required": false; }; "actionsColumnAligmentRight": { "alias": "actionsColumnAligmentRight"; "required": false; }; "actionsColumnWidth": { "alias": "actionsColumnWidth"; "required": false; }; "actionsColumnFrozen": { "alias": "actionsColumnFrozen"; "required": false; }; "rowSelectorColumnActive": { "alias": "rowSelectorColumnActive"; "required": false; }; "rowSelectorColumName": { "alias": "rowSelectorColumName"; "required": false; }; "rowSelectorColumnAligmentRight": { "alias": "rowSelectorColumnAligmentRight"; "required": false; }; "rowSelectorColumnWidth": { "alias": "rowSelectorColumnWidth"; "required": false; }; "rowSelectorColumnFrozen": { "alias": "rowSelectorColumnFrozen"; "required": false; }; "actionsColumnResizable": { "alias": "actionsColumnResizable"; "required": false; }; "actionColumnName": { "alias": "actionColumnName"; "required": false; }; "rowselectorColumnResizable": { "alias": "rowselectorColumnResizable"; "required": false; }; "noDataFoundText": { "alias": "noDataFoundText"; "required": false; }; "showClearSortAndFilters": { "alias": "showClearSortAndFilters"; "required": false; }; "excelReportTitleDefault": { "alias": "excelReportTitleDefault"; "required": false; }; "excelReportTitleAllowUserEdit": { "alias": "excelReportTitleAllowUserEdit"; "required": false; }; "tableViewSaveAs": { "alias": "tableViewSaveAs"; "required": false; }; "tableViewSaveKey": { "alias": "tableViewSaveKey"; "required": false; }; "viewsGetSourceURL": { "alias": "viewsGetSourceURL"; "required": false; }; "viewsSaveSourceURL": { "alias": "viewsSaveSourceURL"; "required": false; }; "maxTableViews": { "alias": "maxTableViews"; "required": false; }; }, { "onRowCheckboxChange": "onRowCheckboxChange"; "onRowSelect": "onRowSelect"; "onRowUnselect": "onRowUnselect"; }, never, never, true, never>;
+}
+
+export { CellOverflowBehaviour, DataAlignHorizontal, DataAlignVertical, DataType, ECSPrimengTable, ECSPrimengTableHttpService, ECSPrimengTableNotificationService, ECSPrimengTableService, FrozenColumnAlign, TableViewSaveMode };
+export type { IColumnMetadata, IExcelExportRequest, IPredifinedFilter, ITableButton, ITableConfiguration, ITablePagedResponse, ITableQueryRequest, ITableView, ITableViewData };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eternalcodestudio/primeng-table",
-  "version": "19.0.0",
+  "version": "20.0.0",
   "description": "ECS reusable Angular PrimeNG table component with advanced server-side filters. Designed to offload filtering logic to any backend API.",
   "author": "ECS (Eternal CODE Studio)",
   "license": "MIT",
@@ -14,10 +14,10 @@
     "ui"
   ],
   "peerDependencies": {
-    "@angular/common": ">=19.0.0",
-    "@angular/core": ">=19.0.0",
-    "primeng": ">=19.0.0",
-    "primeicons": ">=6.0.0"
+    "@angular/common": ">=20.0.0",
+    "@angular/core": ">=20.0.0",
+    "primeng": ">=20.0.0",
+    "primeicons": ">=7.0.0"
   },
   "dependencies": {
     "tslib": "^2.3.0"