@competer/primeng-table 0.0.0-stage → 14.2.0

package/lib/enums/device-type.enum.d.ts

@@ -0,0 +1,6 @@
+/** Viewport categories; numeric values match the backend DeviceType enum. */
+export declare enum DeviceType {
+    Mobile = 0,
+    Tablet = 1,
+    Desktop = 2
+}

package/lib/enums/frozen-column-align.enum.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Enum representing the alignment of frozen columns in a table.
+ *
+ * @remarks
+ * Used to determine if a column should be frozen, and if so, on which side
+ * of the table it should appear.
+ */
+export declare enum FrozenColumnAlign {
+    /** The column is not frozen. */
+    Noone = 0,
+    /** The column is frozen on the left side of the table. */
+    Left = 1,
+    /** The column is frozen on the right side of the table. */
+    Right = 2
+}

package/lib/enums/index.d.ts

@@ -0,0 +1,8 @@
+export * from "./cell-overflow-behaviour.enum";
+export * from "./data-align-horizontal.enum";
+export * from "./data-align-vertical.enum";
+export * from "./data-type.enum.enum";
+export * from "./frozen-column-align.enum";
+export * from "./table-view-save-mode.enum";
+export * from "./device-type.enum";
+export * from "./cell-display.enum";

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

@@ -0,0 +1,17 @@
+/**
+ * Enum representing the mode used to save the state or configuration of a table view.
+ *
+ * @remarks
+ * Determines where and how the table's view settings (e.g., column order, filters,
+ * sorting) are persisted.
+ */
+export declare enum TableViewSaveMode {
+    /** Views are disabled. */
+    None = 0,
+    /** Save the table view state in the browser's sessionStorage (cleared on tab close). */
+    SessionStorage = 1,
+    /** Save the table view state in the browser's localStorage (persists across sessions). */
+    LocalStorage = 2,
+    /** Save the table view state in a backend database (requires server support). */
+    DatabaseStorage = 3
+}

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

@@ -0,0 +1,66 @@
+import { CellDisplay, DeviceType, 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;
+    /** Display name or ngx-translate key. Translated only for display; field and metadata are preserved. */
+    header: string;
+    headerGroup?: string | null;
+    /** The type of data contained in the column. */
+    dataType: DataType;
+    /** Optional presentation; ProgressBar renders numeric values on a 0–100 scale. */
+    cellDisplay?: CellDisplay;
+    /** 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;
+    /** Optional initial visibility. Empty/omitted preserves startHidden; mandatory columns remain visible. */
+    visibleOnlyIn?: DeviceType[] | null;
+    /** 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;
+    /** Optional date format override for this column. */
+    dateFormat: string | null;
+    /** Optional timezone override. */
+    dateTimezone: string | null;
+    /** Optional culture override. */
+    dateCulture: string | null;
+    /** Optional date format for exports override for this column. */
+    exportDateFormat: string | null;
+}

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

@@ -0,0 +1,20 @@
+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;
+    /** If in bools we need to use icons or the underlying boolean value. */
+    useIconInBools: boolean;
+}

package/lib/interfaces/index.d.ts

@@ -0,0 +1,10 @@
+export * from "./table-button.interface";
+export * from "./excel-export-request.interface";
+export * from "./columns-metadata.interface";
+export * from "./predefined-filter.interface";
+export * from "./table-configuration.interface";
+export * from "./table-options.interface";
+export * from "./table-paged-response.interface";
+export * from "./table-query-request.interface";
+export * from "./table-view-data.interface";
+export * from "./table-view.interface";

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

@@ -0,0 +1,101 @@
+/**
+ * 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.
+ */
+export interface IPredefinedFilter {
+    /**
+     * The underlying value of the cell. Must match the data returned from the backend for proper filtering and mapping.
+     *
+     * This is also used by the global filter internally.
+     *
+     * **IMPORTANT**: For text and tag representations, it is recommended that `value` matches `name`.
+     */
+    value: string | number;
+    /**
+     * The text displayed in the frontend for this filter value.
+     *
+     * Used when `displayName` is `true` or when displaying a tag.
+     */
+    name?: string;
+    /**
+     * Set to `true` to display the `name` as text in the cell.
+     */
+    displayName?: boolean;
+    /**
+     * Optional CSS style object to apply to the text when `displayName` is `true`.
+     *
+     * Example: { color: 'blue', fontWeight: 'bold', fontStyle: 'italic' }
+     */
+    nameStyle?: {
+        [key: string]: string;
+    };
+    /**
+     * Set to `true` to display the `name` as a tag in the cell.
+     */
+    displayTag?: boolean;
+    /**
+     * Optional CSS style object to apply to the tag.
+     *
+     * Example: { background: 'rgb(255,0,0)', color: 'white' }
+     */
+    tagStyle?: {
+        [key: string]: string;
+    };
+    /**
+     * The icon to display for this value.
+     *
+     * Can use icons from PrimeNG, Font Awesome, Material Icons, etc...
+     */
+    icon?: string;
+    /**
+     * Optional color to apply to the icon.
+     *
+     * Example: "red", "#00ff00"
+     */
+    iconColor?: string;
+    /**
+     * Optional CSS style string to apply to the icon.
+     *
+     * Example: "font-size: 1.5rem" "margin-right: 0.5rem"
+     */
+    iconStyle?: string;
+    /**
+     * The image to display directly from a URL.
+     */
+    imageURL?: string;
+    /**
+     * The image to display from a Blob object.
+     */
+    imageBlob?: Blob;
+    /**
+     * If using a Blob and it is not provided directly, the backend endpoint to fetch the Blob from.
+     */
+    imageBlobSourceEndpoint?: string;
+    /**
+     * @internal
+     * Indicates that fetching the Blob from `imageBlobSourceEndpoint` failed.
+     *
+     * **_Do not modify this property manually._**
+     */
+    imageBlobFetchError?: boolean;
+    /**
+     * Optional width of the image (and skeleton) in pixels.
+     *
+     * If the value is <= 0 or undefined, the width will not be applied.
+     */
+    imageWidth?: number;
+    /**
+     * Optional height of the image (and skeleton) in pixels.
+     *
+     * If the value is <= 0 or undefined, the height will not be applied.
+     * If no value is specified, a default value of 22px will be used.
+     */
+    imageHeight?: number;
+    /**
+     * Optional. The action to execute when the predefined filter is clicked.
+     * @param rowData The row data object of the clicked row.
+     * @param option The IPredefinedFilter data of the predefined element clicked.
+     */
+    action?: (rowData: any, option: IPredefinedFilter) => void;
+}

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

@@ -0,0 +1,75 @@
+/**
+ * Interface representing a table action button, applicable for both header and row buttons.
+ */
+export interface ITableButton {
+    /**
+     * Optional. The icon to display on the button.
+     * Should be a valid icon name from PrimeNG, Material Icons, Font Awesome, or similar libraries.
+     */
+    icon?: string;
+    /**
+     * Optional. The position of the icon relative to the button label.
+     * Defaults to "left". Possible values are:
+     * - "left"
+     * - "right"
+     * - "top"
+     * - "bottom"
+     */
+    iconPos?: string;
+    /**
+     * Optional. The text label displayed on the button.
+     */
+    label?: string;
+    /**
+     * Optional. If true, the button will be round. Defaults to false.
+     */
+    rounded?: boolean;
+    /**
+     * Optional. If true, adds a shadow to indicate elevation. Defaults to false.
+     */
+    raised?: boolean;
+    /**
+     * Optional. Specifies the variant of the button.
+     * Can be null (default), "text", or "outlined".
+     */
+    variant?: string;
+    /**
+     * Optional. Extra CSS classes to apply to the button.
+     */
+    class?: string;
+    /**
+     * Optional. Additional inline CSS styles for the button.
+     */
+    style?: string;
+    /**
+     * Optional. Function that determines whether the button should be visible for a given row.
+     * @param rowData The row data object. Null for header buttons.
+     * @returns True if the button should be visible; false otherwise.
+     */
+    visibleCondition?: (rowData: any) => boolean;
+    /**
+     * Optional. Function that determines whether the button should be displayed for a given row.
+     *
+     * Ignored if `visibleCondition` returns false.
+     * @param rowData The row data object. Null for header buttons.
+     * @returns True if the button should be enabled; false otherwise.
+     */
+    enabledCondition?: (rowData: any) => boolean;
+    /**
+     * Optional. Controls behavior when `enabledCondition` returns false.
+     * - If `true`, the button will be hidden when the 'enabledCondition' is not met.
+     * - If `false` or `undefined`, the button will remain visible but disabled if 'enabledCondition' is not met.
+     *
+     * Ignored if `visibleCondition` returns false.
+     */
+    conditionFailHide?: boolean;
+    /**
+     * Optional. The action to execute when the button is clicked.
+     * @param rowData The row data object of the clicked row. Null for header buttons.
+     */
+    action?: (rowData: any) => void;
+    /**
+     * Optional. Tooltip text to display when the user hovers over the button.
+     */
+    tooltip?: string;
+}

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

@@ -0,0 +1,23 @@
+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;
+    /** The format used for displaying dates in the exports. */
+    exportDateFormat: string;
+}