@eternalcodestudio/primeng-table 19.0.2 → 19.0.3

package/lib/components/ecs-primeng-table/ecs-primeng-table.d.ts

@@ -139,16 +139,6 @@ export declare class ECSPrimengTable implements OnInit, AfterViewInit {
      * @param {IPrimengPredefinedFilter[]} selectedValues - An array of selected predefined filter values.
      */
     onPredefinedFilterChange(filterName: string, selectedValues: IPredefinedFilter[]): 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.
-     */
-    predefinedFiltersSelectedValuesText(columnKeyName: string): string;
     /**
      * 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.

package/lib/components/table-cell/table-cell.d.ts

@@ -1,11 +1,12 @@
 import { DataAlignHorizontal, DataAlignVertical, DataType } from '../../enums';
 import { DatePipe } from '@angular/common';
 import { IColumnMetadata, IPredefinedFilter } from '../../interfaces';
-import { SafeHtml } from '@angular/platform-browser';
+import { DomSanitizer, SafeHtml } from '@angular/platform-browser';
 import * as i0 from "@angular/core";
 export declare class TableCell {
     private datePipe;
-    constructor(datePipe: DatePipe);
+    private sanitizer;
+    constructor(datePipe: DatePipe, sanitizer: DomSanitizer);
     col: any;
     rowData: any;
     globalSearchText: string | null;

package/lib/enums/cell-overflow-behaviour.enum.d.ts

@@ -1,14 +1,12 @@
 /**
- * Enum representing how content that overflows a table cell should be handled.
+ * Defines how content that overflows a table cell is displayed.
  *
  * @remarks
- * Determines the visual behavior of cell content when it exceeds the cell's width.
+ * This enumeration specifies the visual behavior of cell content when it exceeds the cell’s width.
  */
 export declare enum CellOverflowBehaviour {
-    /** Content that exceeds the cell's width is clipped and not visible. */
+    /** The overflowing content is clipped and not visible. */
     Hidden = 0,
-    /** Content wraps onto multiple lines to fit within the cell. */
-    Wrap = 1,
-    /** Content is truncated and an ellipsis (...) is shown at the end. */
-    Ellipsis = 2
+    /** The content wraps onto multiple lines to fit within the cell. */
+    Wrap = 1
 }

package/lib/enums/data-align-horizontal.enum.d.ts

@@ -1,14 +1,14 @@
 /**
- * Enum representing the horizontal alignment of content within a table cell.
+ * Defines the horizontal alignment of content within a table cell.
  *
  * @remarks
- * Determines how the content inside a cell is positioned horizontally relative to the cell's width.
+ * Specifies how the content inside a cell is positioned horizontally relative to the cell's width.
  */
 export declare enum DataAlignHorizontal {
-    /** Align content to the left of the cell. */
+    /** Content is aligned to the left side of the cell. */
     Left = 0,
-    /** Align content to the center of the cell. */
+    /** Content is aligned to the center of the cell. */
     Center = 1,
-    /** Align content to the right of the cell. */
+    /** Content is aligned to the right side of the cell. */
     Right = 2
 }

package/lib/enums/table-view-save-mode.enum.d.ts

@@ -6,7 +6,7 @@
  * sorting) are persisted.
  */
 export declare enum TableViewSaveMode {
-    /** Do not save the table view state. */
+    /** Views are disabled. */
     None = 0,
     /** Save the table view state in the browser's sessionStorage (cleared on tab close). */
     SessionStorage = 1,

package/lib/interfaces/columns-metadata.interface.d.ts

@@ -1,25 +1,53 @@
 import { CellOverflowBehaviour, DataAlignHorizontal, DataAlignVertical, DataType, FrozenColumnAlign } from "../enums";
+/**
+ * Represents the metadata for a column in a table.
+ *
+ * @remarks
+ * Provides configuration for column behavior, appearance, and user interactions.
+ */
 export interface IColumnMetadata {
+    /** The key or identifier for the column's data field. */
     field: string;
+    /** The display name of the column header. */
     header: string;
+    /** The type of data contained in the column. */
     dataType: DataType;
+    /** The horizontal alignment of the column content. */
     dataAlignHorizontal: DataAlignHorizontal;
+    /** Indicates whether the horizontal alignment can be modified by the user. */
     dataAlignHorizontalAllowUserEdit: boolean;
+    /** The vertical alignment of the column content. */
     dataAlignVertical: DataAlignVertical;
+    /** Indicates whether the vertical alignment can be modified by the user. */
     dataAlignVerticalAllowUserEdit: boolean;
+    /** Determines if the column can be hidden. */
     canBeHidden: boolean;
+    /** Determines if the column should initially be hidden. */
     startHidden: boolean;
+    /** Determines if the column can be resized by the user. */
     canBeResized: boolean;
+    /** Determines if the column can be reordered by the user. */
     canBeReordered: boolean;
+    /** Determines if the column can be sorted. */
     canBeSorted: boolean;
+    /** Determines if the column can be filtered. */
     canBeFiltered: boolean;
+    /** Name of predefined filter values, if any. */
     filterPredefinedValuesName: string;
+    /** Determines if the column can be included in global filtering. */
     canBeGlobalFiltered: boolean;
+    /** Description or tooltip text for the column. */
     columnDescription: string;
+    /** Determines if a tooltip should be shown for the column data. */
     dataTooltipShow: boolean;
+    /** Custom source for the tooltip content, if applicable. */
     dataTooltipCustomColumnSource: string;
+    /** Alignment for frozen columns (left or right). */
     frozenColumnAlign: FrozenColumnAlign;
+    /** Specifies how overflowing content is handled within the cell. */
     cellOverflowBehaviour: CellOverflowBehaviour;
+    /** Indicates whether the cell overflow behavior can be modified by the user. */
     cellOverflowBehaviourAllowUserEdit: boolean;
+    /** Initial width of the column in pixels. */
     initialWidth: number;
 }

package/lib/interfaces/excel-export-request.interface.d.ts

@@ -1,7 +1,18 @@
 import { ITableQueryRequest } from "./table-query-request.interface";
+/**
+ * Represents the request parameters for exporting table data to Excel.
+ *
+ * @remarks
+ * Extends `ITableQueryRequest` to include Excel-specific options such as filename,
+ * column selection, and whether to apply current filters and sorts.
+ */
 export interface IExcelExportRequest extends ITableQueryRequest {
+    /** The desired name of the exported Excel file. */
     filename: string;
+    /** Determines whether all columns should be included in the export. */
     allColumns: boolean;
+    /** Determines whether the current table filters should be applied in the export. */
     applyFilters: boolean;
+    /** Determines whether the current table sorting should be applied in the export. */
     applySorts: boolean;
 }

package/lib/interfaces/predefined-filter.interface.d.ts

@@ -1,5 +1,5 @@
 /**
- * Represents a predefined filter value for a column in **ECS PrimeNG tables**.
+ * Represents a predefined filter value for a column in **ECS PrimeNG table**.
  *
  * Allows displaying a value as text, tag, icon or image (from URL or blob) with optional styles and colors.
  */

package/lib/interfaces/table-configuration.interface.d.ts

@@ -1,9 +1,21 @@
 import { IColumnMetadata } from "../interfaces";
+/**
+ * Represents the configuration settings for a table.
+ *
+ * @remarks
+ * Contains column definitions, pagination options, date formatting, and other table-related settings.
+ */
 export interface ITableConfiguration {
+    /** Array of metadata objects defining each column in the table. */
     columnsInfo: IColumnMetadata[];
+    /** Allowed options for the number of items displayed per page. */
     allowedItemsPerPage: number[];
+    /** The format used for displaying dates in the table. */
     dateFormat: string;
+    /** The timezone applied when formatting date values. */
     dateTimezone: string;
+    /** The culture/locale used for date and number formatting. */
     dateCulture: string;
+    /** Maximum number of table views that can be saved or tracked. */
     maxViews: number;
 }

package/lib/interfaces/table-options.interface.d.ts

@@ -44,6 +44,66 @@ export interface ITableOptions {
      * @default []
      */
     data?: any[];
+    /**
+     * Configuration options for the table description section.
+     */
+    description?: {
+        /**
+         * Icon displayed alongside the table description.
+         * You can use any PrimeIcons class or icons from third-party libraries
+         * such as Material Icons or Font Awesome.
+         *
+         * @default "pi pi-info-circle"
+         */
+        icon?: string;
+        /**
+         * Determines how the description text is displayed.
+         * - `true`, the `text` content is shown as a tooltip when hovering
+         * over the description icon.
+         * - `false`, the `text` is displayed inline to the right of the icon.
+         *
+         * @default true
+         */
+        tooltip?: boolean;
+        /**
+         * The description content to display.
+         * If left undefined or string empty, the table description will not be rendered.
+         * Supports basic HTML for rich text formatting.
+         *
+         * @default undefined
+         */
+        text?: string;
+    };
+    /**
+     * Configuration options for the table legend.
+     */
+    legend?: {
+        /**
+         * The content to be displayed in the popover of the legend. Can be HTML rich.
+         *
+         * @default undefined
+         */
+        content?: string;
+        /**
+         * Configuration options for the button that displays the popover of the table legend.
+         */
+        button?: {
+            /**
+             * Icon displayed alongside the button of the table legend.
+             * You can use any PrimeIcons class or icons from third-party libraries
+             * such as Material Icons or Font Awesome.
+             *
+             * @default "pi pi-bars"
+             */
+            icon?: string;
+            /**
+             * The text shown in the legend button.
+             *
+             * @default "Legend"
+             */
+            text?: string;
+        };
+    };
     /**
      * Configurations related to options that are at the header of the table.
      */
@@ -430,4 +490,5 @@ export interface ITableOptions {
      */
     copyToClipboardTime?: number;
 }
+/** Default configuration options for ECS Primeng table */
 export declare const DEFAULT_TABLE_OPTIONS: ITableOptions;

package/lib/interfaces/table-paged-response.interface.d.ts

@@ -1,6 +1,16 @@
+/**
+ * Represents a paged response from a table query.
+ *
+ * @remarks
+ * Provides information about the current page, total records, and the data for the page.
+ */
 export interface ITablePagedResponse {
+    /** The current page number. */
     page: number;
+    /** Total number of records after applying any filters. */
     totalRecords: number;
+    /** Total number of records without applying any filters. */
     totalRecordsNotFiltered: number;
+    /** The data items for the current page. */
     data: any;
 }

package/lib/interfaces/table-query-request.interface.d.ts

@@ -1,11 +1,26 @@
+/**
+ * Represents a request for querying table data with pagination, sorting, and filtering.
+ *
+ * @remarks
+ * Includes information about page, page size, sorting, filters, and date formatting options.
+ */
 export interface ITableQueryRequest {
+    /** The current page number. */
     page: number;
+    /** The number of items per page. */
     pageSize: number;
+    /** Optional sorting configuration. */
     sort?: any;
+    /** Filter criteria for the query. */
     filter: any;
+    /** Optional global filter applied across all columns. */
     globalFilter?: string | null;
+    /** Optional array of column names to include in the query. */
     columns?: string[];
+    /** The date format used for query parameters. */
     dateFormat: string;
+    /** The timezone used for formatting date values. */
     dateTimezone: string;
+    /** The culture/locale used for formatting dates and numbers. */
     dateCulture: string;
 }

package/lib/interfaces/table-view-data.interface.d.ts

@@ -1,12 +1,26 @@
 import { SortMeta } from "primeng/api";
 import { IColumnMetadata } from "./columns-metadata.interface";
+/**
+ * Represents the current state and configuration of a table view.
+ *
+ * @remarks
+ * Includes information about displayed columns, widths, sorting, filtering, and pagination.
+ */
 export interface ITableViewData {
+    /** Array of columns currently visible in the table. */
     columnsShown: IColumnMetadata[];
+    /** The total width of the table in pixels. */
     tableWidth: any;
+    /** Widths of individual columns as a formatted string (in pixels). */
     columnsWidth: string;
+    /** Sorting metadata for multiple columns, if applicable. */
     multiSortMeta: SortMeta[] | null | undefined;
+    /** Current filter settings applied to the table. */
     filters: any;
+    /** Text used for global search across all columns, if any. */
     globalSearchText: string | null;
+    /** The current page number. */
     currentPage: number;
+    /** The number of rows displayed per page. */
     currentRowsPerPage: number;
 }

package/lib/interfaces/table-view.interface.d.ts

@@ -1,6 +1,15 @@
 import { ITableViewData } from "./table-view-data.interface";
+/**
+ * Represents a saved or active view of a table.
+ *
+ * @remarks
+ * Contains information about whether the view is currently active, its alias, and the view data.
+ */
 export interface ITableView {
+    /** Indicates if this view is the last active one. */
     lastActive: boolean;
+    /** Alias or name of the view. */
     viewAlias: string;
+    /** The detailed data and configuration for this view. */
     viewData: ITableViewData;
 }

package/lib/utils/data-align-horizontal-as-text.d.ts

@@ -1,2 +1,11 @@
 import { DataAlignHorizontal } from "../enums";
+/**
+ * Converts a `DataAlignHorizontal` enum value to its corresponding CSS text alignment string.
+ *
+ * @param dataAlignHorizontal - The horizontal alignment enum value.
+ * @returns The CSS text alignment string ('left', 'center', or 'right').
+ *
+ * @remarks
+ * If an unknown value is provided, the function defaults to 'center'.
+ */
 export declare function dataAlignHorizontalAsText(dataAlignHorizontal: DataAlignHorizontal): string;

package/lib/utils/data-align-vertical-as-text.d.ts

@@ -1,2 +1,11 @@
 import { DataAlignVertical } from "../enums";
+/**
+ * Converts a `DataAlignVertical` enum value to its corresponding CSS vertical alignment string.
+ *
+ * @param dataAlignVertical - The vertical alignment enum value.
+ * @returns The CSS vertical alignment string ('top', 'middle', or 'bottom').
+ *
+ * @remarks
+ * If an unknown value is provided, the function defaults to 'middle'.
+ */
 export declare function dataAlignVerticalAsText(dataAlignVertical: DataAlignVertical): string;

package/lib/utils/data-type-as-text.d.ts

@@ -1,2 +1,11 @@
 import { DataType } from "../enums";
+/**
+ * Converts a `DataType` enum value to its corresponding string representation.
+ *
+ * @param dataType - The data type enum value.
+ * @returns The string representation of the data type ('text', 'numeric', 'boolean', or 'date').
+ *
+ * @remarks
+ * If an unknown value is provided, the function defaults to 'text'.
+ */
 export declare function dataTypeAsText(dataType: DataType): string;

package/lib/utils/frozen-column-align-as-text.d.ts

@@ -1,2 +1,11 @@
 import { FrozenColumnAlign } from "../enums";
+/**
+ * Converts a `FrozenColumnAlign` enum value to its corresponding CSS alignment string.
+ *
+ * @param frozenColumnAlign - The frozen column alignment enum value.
+ * @returns The CSS alignment string ('left' or 'right').
+ *
+ * @remarks
+ * If an unknown value is provided, the function defaults to 'left'.
+ */
 export declare function frozenColumnAlignAsText(frozenColumnAlign: FrozenColumnAlign): string;

package/lib/utils/highlight-text.d.ts

@@ -1,24 +1,17 @@
-import { SafeHtml } from "@angular/platform-browser";
+import { DomSanitizer, SafeHtml } from '@angular/platform-browser';
 import { IColumnMetadata } from "../interfaces";
 /**
- * Generates SafeHtml with highlighted text based on global search criteria.
+ * Generates sanitized HTML (`SafeHtml`) with highlighted text based on a global search term.
  *
- * @param {any} cellValue - The value of the cell to be highlighted.
- * @param {IprimengColumnsMetadata} colMetadata - The column configuration for the cell.
- * @param {string | null} globalSearchText - The global search text to highlight within the cell value.
- * @returns {SafeHtml} - HTML content with highlighted text if it matches the global search criteria.
+ * @remarks
+ * This utility safely creates HTML content where occurrences of the provided global search text
+ * within the cell value are wrapped in a `<span class="highlighted-text">` tag for visual emphasis.
+ * If the cell does not match the search text or is of type `Boolean`, the original value is returned as safe HTML.
  *
- * @example
- * // Define column configuration
- * const colMetadata: IprimengColumnsMetadata = { dataType: 'string', canBeGlobalFiltered: true, etc... };
- *
- * // Cell value to be highlighted
- * const cellValue: string = 'Example text';
- *
- * // Global search text
- * const globalSearchText: string = 'text';
- *
- * // Use highlightText to get SafeHtml with highlighted text
- * const highlightedHtml: SafeHtml = highlightText(cellValue, colMetadata, globalSearchText);
+ * @param {any} cellValue - The cell's value that may contain the text to highlight.
+ * @param {IColumnMetadata} colMetadata - Metadata configuration of the column that defines its data type and filtering behavior.
+ * @param {string | null} globalSearchText - The search text to highlight if found within the cell's content.
+ * @param {DomSanitizer} sanitizer - Angular's sanitizer used to safely produce trusted HTML content.
+ * @returns {SafeHtml} A `SafeHtml` instance containing highlighted HTML when a match is found, or the original sanitized text otherwise.
  */
-export declare function highlightText(cellValue: any, colMetadata: IColumnMetadata, globalSearchText: string | null): SafeHtml;
+export declare function highlightText(cellValue: any, colMetadata: IColumnMetadata, globalSearchText: string | null, sanitizer: DomSanitizer): SafeHtml;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eternalcodestudio/primeng-table",
-  "version": "19.0.2",
+  "version": "19.0.3",
   "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",

package/public-api.d.ts

@@ -1,6 +1,9 @@
-export * from './lib/components/ecs-primeng-table/ecs-primeng-table';
-export * from './lib/components/ecs-primeng-table/ecs-primeng-table.service';
 export * from './lib/enums';
-export * from './lib/interfaces';
-export * from './lib/services';
+export * from './lib/interfaces/columns-metadata.interface';
+export * from './lib/interfaces/predefined-filter.interface';
+export * from './lib/interfaces/table-button.interface';
+export * from './lib/interfaces/table-options.interface';
 export * from "./lib/utils/create-table-options";
+export * from './lib/services';
+export * from './lib/components/ecs-primeng-table/ecs-primeng-table';
+export * from './lib/components/ecs-primeng-table/ecs-primeng-table.service';