@servicemind.tis/tis-smart-table-viewer 2.2.0 → 2.3.1

package/lib/components/tis-smart-table-viewer/tis-smart-table-viewer.component.d.ts

@@ -1,4 +1,4 @@
-import { EventEmitter, SimpleChanges } from '@angular/core';
+import { EventEmitter, SimpleChanges, OnDestroy } from '@angular/core';
 import { FormGroup, FormControl } from '@angular/forms';
 import { ActivatedRoute, Router } from '@angular/router';
 import { Subscription, Observable } from 'rxjs';
@@ -17,7 +17,7 @@ import { Location } from '@angular/common';
 import type { DataNotFoundConfig } from '../../interfaces/data-not-found-config.type';
 import type { ColumnCustomizationUrlConfig } from '../../interfaces/url-config.type';
 import * as i0 from "@angular/core";
-export declare class TisSmartTableViewerComponent {
+export declare class TisSmartTableViewerComponent implements OnDestroy {
     private dialog;
     private apiService;
     private route;
@@ -85,6 +85,15 @@ export declare class TisSmartTableViewerComponent {
     search: string;
     searchCtrl: FormControl<any>;
     private _onDestroy;
+    private _selectionSubscription;
+    private _handsetSubscription;
+    private _queryParamsSubscription;
+    private _columnMappingCache;
+    private _displayedColumnsCache;
+    private _lastColumnsCodeMappingHash;
+    private _currentRequestSubject;
+    private timeoutManager;
+    private computedRowBackgrounds;
     dataSource: ApiDataSource;
     private _sort;
     private _sortSubscription;
@@ -111,6 +120,7 @@ export declare class TisSmartTableViewerComponent {
     isExpandedRow: boolean;
     expandedTemplate: any;
     isAllExpanded: boolean;
+    private expandedRowIds;
     isHandset$: Observable<boolean>;
     isMobile: boolean;
     constructor(dialog: MatDialog, apiService: ApiService, route: ActivatedRoute, router: Router, location: Location, breakpointObserver: BreakpointObserver);
@@ -119,6 +129,19 @@ export declare class TisSmartTableViewerComponent {
     ngOnDestroy(): void;
     setDefaultColumns(): void;
     handleDisplayedColumns(): void;
+    private updateColumnMappingCache;
+    trackByBreadcrumb(index: number, breadcrumb: {
+        url: string;
+        name: string;
+    }): string;
+    trackByFilterValue(index: number, filterValue: SelectedFilterDisplayValueType): string;
+    trackByAutoColumn(index: number, column: SmartTableWrapperColumnsConfig): string;
+    trackByTemplateColumn(index: number, column: SmartTableWrapperColumnsConfig): string;
+    trackByTableRow(index: number, row: any): any;
+    private getRowIdentifier;
+    isRowExpanded(row: any): boolean;
+    private clearRowBackgroundCache;
+    private computeAllRowBackgrounds;
     handleSortingChanges(ch: any): void;
     private getHomeUrl;
     getNestedValue(obj: any, path: string): any;

package/lib/datasources/api.datasource.d.ts

@@ -1,5 +1,5 @@
 import { CollectionViewer, DataSource } from '@angular/cdk/collections';
-import { BehaviorSubject, Observable } from 'rxjs';
+import { BehaviorSubject, Observable, Subject } from 'rxjs';
 import { ApiService } from '../services/api.service';
 export declare class ApiDataSource implements DataSource<any> {
     private apiService;
@@ -14,4 +14,5 @@ export declare class ApiDataSource implements DataSource<any> {
     connect(collectionViewer: CollectionViewer): Observable<any[]>;
     disconnect(collectionViewer: CollectionViewer): void;
     load(url: string, pageIndex: number, pageSize: number, search: string, filter?: object, sortFilter?: object): void;
+    loadWithCancellation(url: string, pageIndex: number, pageSize: number, search: string, filter?: object, sortFilter?: object, cancelSubject?: Subject<void>): void;
 }

package/lib/helpers/collection.helper.d.ts

@@ -0,0 +1,92 @@
+/**
+ * Centralized collection management utility helper for common array and object operations.
+ * Provides reusable functions for managing collections, selections, and data structures.
+ */
+export declare class CollectionHelper {
+    /**
+     * Safely clears an array if it exists
+     * @param array - Array to clear
+     */
+    static clearArray(array: any[]): void;
+    /**
+     * Safely clears a Set if it exists
+     * @param set - Set to clear
+     */
+    static clearSet(set: Set<any>): void;
+    /**
+     * Safely clears a Map if it exists
+     * @param map - Map to clear
+     */
+    static clearMap(map: Map<any, any>): void;
+    /**
+     * Gets a consistent identifier for a row based on available keys
+     * @param row - Row object
+     * @param primaryKey - Primary key property name (default: 'id')
+     * @param fallbackKey - Fallback key property name
+     * @returns Row identifier or JSON string as last resort
+     */
+    static getRowIdentifier(row: any, primaryKey?: string, fallbackKey?: string): string | number;
+    /**
+     * Creates a hash from an array of objects for cache validation
+     * @param items - Array of items to hash
+     * @param keyExtractor - Function to extract key from each item
+     * @returns Hash string
+     */
+    static createArrayHash<T>(items: T[], keyExtractor: (item: T) => string): string;
+    /**
+     * Safely filters an array with predicate function
+     * @param array - Array to filter
+     * @param predicate - Filter predicate function
+     * @returns Filtered array or empty array if input is invalid
+     */
+    static safeFilter<T>(array: T[], predicate: (item: T) => boolean): T[];
+    /**
+     * Safely maps an array with transform function
+     * @param array - Array to map
+     * @param transform - Transform function
+     * @returns Mapped array or empty array if input is invalid
+     */
+    static safeMap<T, U>(array: T[], transform: (item: T) => U): U[];
+    /**
+     * Safely finds an item in array
+     * @param array - Array to search
+     * @param predicate - Find predicate function
+     * @returns Found item or undefined
+     */
+    static safeFind<T>(array: T[], predicate: (item: T) => boolean): T | undefined;
+    /**
+     * Creates a Map from an array for O(1) lookups
+     * @param array - Array to convert
+     * @param keyExtractor - Function to extract key from each item
+     * @returns Map with keys and items
+     */
+    static createLookupMap<T>(array: T[], keyExtractor: (item: T) => string): Map<string, T>;
+    /**
+     * Checks if two arrays have the same items (order doesn't matter)
+     * @param array1 - First array
+     * @param array2 - Second array
+     * @param keyExtractor - Function to extract comparison key
+     * @returns True if arrays contain same items
+     */
+    static arraysEqual<T>(array1: T[], array2: T[], keyExtractor?: (item: T) => any): boolean;
+    /**
+     * Safely removes items from a Set based on a predicate
+     * @param set - Set to modify
+     * @param predicate - Function to determine if item should be removed
+     */
+    static removeFromSet<T>(set: Set<T>, predicate: (item: T) => boolean): void;
+    /**
+     * Safely clones an array to prevent mutation issues
+     * @param array - Array to clone
+     * @returns Cloned array or empty array if input is invalid
+     */
+    static cloneArray<T>(array: T[]): T[];
+    /**
+     * Performs safe property access with default value
+     * @param obj - Object to access
+     * @param path - Property path (e.g., 'user.profile.name')
+     * @param defaultValue - Default value if property doesn't exist
+     * @returns Property value or default
+     */
+    static getNestedProperty(obj: any, path: string, defaultValue?: any): any;
+}

package/lib/helpers/date-time.helper.d.ts

@@ -0,0 +1,39 @@
+import { DateTime } from 'luxon';
+/**
+ * Centralized date/time utility helper for consistent date handling across the library.
+ * Provides common date formatting and conversion functions to avoid code duplication.
+ */
+export declare class DateTimeHelper {
+    /**
+     * Formats a date value for display based on form control type
+     * @param value - The date value (Date, DateTime, string, number)
+     * @param formControlType - The type of form control ('date', 'date-time', etc.)
+     * @returns Formatted date string
+     */
+    static formatForDisplay(value: any, formControlType: string): string;
+    /**
+     * Converts various date formats to DateTime object
+     * @param value - Date value in various formats
+     * @returns DateTime object or null if invalid
+     */
+    static toDateTime(value: any): DateTime | null;
+    /**
+     * Converts date/DateTime objects to milliseconds for API calls
+     * @param value - Date value
+     * @returns Milliseconds or original value if not a date
+     */
+    static toMilliseconds(value: any): any;
+    /**
+     * Checks if a query parameter key represents a date field
+     * @param key - Query parameter key
+     * @param value - Query parameter value
+     * @returns True if it's a date field
+     */
+    static isDateQueryParam(key: string, value: string): boolean;
+    /**
+     * Parses date from query parameters
+     * @param value - Query parameter value (milliseconds as string)
+     * @returns DateTime object
+     */
+    static parseFromQueryParam(value: string): DateTime;
+}

package/lib/helpers/filter-display.helper.d.ts

@@ -0,0 +1,51 @@
+import type { SelectedFilterDisplayValueType, SelectedFiltersGroupedValuesType, SelectedFilterDisplayValuesType } from '../interfaces';
+/**
+ * Centralized filter display utility helper for managing filter value formatting and grouping.
+ * Handles the complex logic of grouping and displaying filter values in a consistent manner.
+ */
+export declare class FilterDisplayHelper {
+    /**
+     * Formats filter values based on form control type for display
+     * @param items - Array of filter display values
+     * @returns Processed array with formatted display values
+     */
+    static formatFilterValuesForDisplay(items: SelectedFilterDisplayValueType[]): SelectedFilterDisplayValueType[];
+    /**
+     * Groups filter values by form control attributes
+     * @param data - Array of filter display values
+     * @returns Grouped filter values
+     */
+    static groupByFormControlAttributes(data: SelectedFilterDisplayValueType[]): SelectedFiltersGroupedValuesType[];
+    /**
+     * Determines if a form control should only have single values
+     * @param formControlType - Type of form control
+     * @param explicitSingleValue - Explicit single value flag
+     * @returns True if single value control
+     */
+    static isSingleValueFormControl(formControlType: string, explicitSingleValue?: boolean): boolean;
+    /**
+     * Updates selected filter values by replacing values for a specific form control
+     * @param currentValues - Current selected filter values
+     * @param newValues - New values to add/update
+     * @param formControlName - Name of the form control being updated
+     * @returns Updated filter values and grouped values
+     */
+    static updateSelectedFilterValues(currentValues: SelectedFilterDisplayValuesType, newValues: SelectedFilterDisplayValueType | SelectedFilterDisplayValuesType, formControlName?: string): {
+        selectedFilterValues: SelectedFilterDisplayValuesType;
+        selectedFilterGroupedValues: SelectedFiltersGroupedValuesType[];
+    };
+    /**
+     * Filters selected values to only show those present in query parameters
+     * @param selectedValues - All selected filter values
+     * @param queryParams - Current query parameters
+     * @returns Filtered values for display
+     */
+    static getValuesForDisplay(selectedValues: SelectedFilterDisplayValuesType, queryParams: any): SelectedFilterDisplayValuesType;
+    /**
+     * Removes a specific filter value from the collection
+     * @param selectedValues - Current selected filter values
+     * @param filterToRemove - Filter value to remove
+     * @returns Updated filter values
+     */
+    static removeFilterValue(selectedValues: SelectedFilterDisplayValuesType, filterToRemove: SelectedFilterDisplayValueType): SelectedFilterDisplayValuesType;
+}

package/lib/helpers/query-params.helper.d.ts

@@ -0,0 +1,47 @@
+/**
+ * Centralized query parameter utility helper for consistent URL parameter handling.
+ * Provides common functions for parsing, validating, and transforming query parameters.
+ */
+export declare class QueryParamsHelper {
+    /**
+     * Parses query parameters from URL and handles type conversions
+     * @param url - Full URL string
+     * @returns Parsed query parameters object
+     */
+    static parseQueryParams(url: string): Record<string, string | string[]>;
+    /**
+     * Checks if a query parameter value is valid (not empty, null, or undefined)
+     * @param value - Query parameter value
+     * @returns True if valid
+     */
+    static isValidParam(value: any): boolean;
+    /**
+     * Processes a query parameter value and handles arrays
+     * @param value - Raw query parameter value
+     * @returns Processed value (string or array)
+     */
+    static processParamValue(value: string): string | string[];
+    /**
+     * Processes query parameters for filter form with type conversions
+     * @param queryParams - Raw query parameters
+     * @param columnsCodeMapping - Column mapping for transformations
+     * @returns Processed filter and sort objects
+     */
+    static processForFilters(queryParams: any, columnsCodeMapping: any[]): {
+        filterParams: any;
+        sortParams: any;
+        pageIndex: number;
+        pageSize: number;
+        search: string;
+    };
+    /**
+     * Builds query string from filter data with proper encoding
+     * @param filterData - Filter form data
+     * @param sortParams - Sort parameters
+     * @param pageIndex - Current page index
+     * @param pageSize - Current page size
+     * @param search - Search term
+     * @returns URLSearchParams object
+     */
+    static buildQueryString(filterData: any, sortParams: any, pageIndex: number, pageSize: number, search: string): URLSearchParams;
+}

package/lib/helpers/timeout-manager.helper.d.ts

@@ -0,0 +1,72 @@
+/**
+ * TimeoutManager - A utility class for managing timeouts to prevent memory leaks
+ *
+ * This class provides a centralized way to create, track, and clean up setTimeout calls.
+ * It automatically handles cleanup when component is destroyed to prevent memory leaks.
+ *
+ * @example
+ * ```typescript
+ * export class MyComponent implements OnDestroy {
+ *   private timeoutManager = new TimeoutManager();
+ *
+ *   someMethod() {
+ *     this.timeoutManager.createTimeout(() => {
+ *       console.log('Delayed execution');
+ *     }, 1000);
+ *   }
+ *
+ *   ngOnDestroy() {
+ *     this.timeoutManager.clearAll(); // Clean up all pending timeouts
+ *   }
+ * }
+ * ```
+ */
+export declare class TimeoutManager {
+    private activeTimeouts;
+    /**
+     * Creates a tracked timeout that will be automatically cleaned up
+     * @param callback - Function to execute after delay
+     * @param delay - Delay in milliseconds
+     * @returns The timeout ID (same as setTimeout return value)
+     */
+    createTimeout(callback: () => void, delay: number): ReturnType<typeof setTimeout>;
+    /**
+     * Manually clear a specific timeout
+     * @param timeoutId - The timeout ID returned from createTimeout
+     */
+    clearTimeout(timeoutId: ReturnType<typeof setTimeout>): void;
+    /**
+     * Clear all pending timeouts
+     * This should be called in ngOnDestroy to prevent memory leaks
+     */
+    clearAll(): void;
+    /**
+     * Get the number of active (pending) timeouts
+     * Useful for debugging and testing
+     */
+    get activeCount(): number;
+    /**
+     * Check if a specific timeout is still active
+     * @param timeoutId - The timeout ID to check
+     */
+    isActive(timeoutId: ReturnType<typeof setTimeout>): boolean;
+}
+/**
+ * Static helper functions for one-off timeout usage
+ * Use the TimeoutManager class for more comprehensive timeout management
+ */
+export declare class TimeoutHelper {
+    /**
+     * Create a single tracked timeout with external cleanup responsibility
+     * @param callback - Function to execute after delay
+     * @param delay - Delay in milliseconds
+     * @param trackingSet - Set to track the timeout for cleanup
+     * @returns The timeout ID
+     */
+    static createTrackedTimeout(callback: () => void, delay: number, trackingSet: Set<ReturnType<typeof setTimeout>>): ReturnType<typeof setTimeout>;
+    /**
+     * Clear all timeouts in a tracking set
+     * @param trackingSet - Set containing timeout IDs to clear
+     */
+    static clearAllTimeouts(trackingSet: Set<ReturnType<typeof setTimeout>>): void;
+}

package/lib/helpers/url.helper.d.ts

@@ -0,0 +1,78 @@
+import { Location } from '@angular/common';
+import { Router } from '@angular/router';
+/**
+ * Centralized URL and navigation utility helper.
+ * Provides common functions for URL manipulation and navigation.
+ */
+export declare class UrlHelper {
+    /**
+     * Extracts the home URL from current window location
+     * @returns Home URL path
+     */
+    static getHomeUrl(): string;
+    /**
+     * Safely navigates to a URL if it's valid
+     * @param router - Angular Router instance
+     * @param url - URL to navigate to
+     * @returns Promise<boolean> - Navigation result
+     */
+    static safeNavigate(router: Router, url: string): Promise<boolean> | null;
+    /**
+     * Updates the browser URL without navigation using Location service
+     * @param location - Angular Location service
+     * @param baseUrl - Base URL path
+     * @param queryString - Query string parameters
+     */
+    static updateUrl(location: Location, baseUrl: string, queryString: string): void;
+    /**
+     * Builds a complete URL with query parameters
+     * @param baseUrl - Base URL path
+     * @param queryParams - URLSearchParams object
+     * @returns Complete URL string
+     */
+    static buildUrl(baseUrl: string, queryParams: URLSearchParams): string;
+    /**
+     * Gets the base URL without query parameters
+     * @param router - Angular Router instance
+     * @returns Base URL string
+     */
+    static getBaseUrl(router: Router): string;
+    /**
+     * Checks if current URL differs from generated URL
+     * @param generatedUrl - Generated URL to compare
+     * @returns True if URLs are different
+     */
+    static hasUrlChanged(generatedUrl: string): boolean;
+    /**
+     * Extracts query parameters from a URL string
+     * @param url - Full URL string
+     * @returns URLSearchParams object
+     */
+    static extractQueryParams(url: string): URLSearchParams | null;
+    /**
+     * Handles button click actions (URL navigation or callback execution)
+     * @param router - Angular Router instance
+     * @param config - Button configuration object
+     * @param primaryUrlKey - Primary URL property name (default: 'btnUrl')
+     * @param primaryClickKey - Primary click handler property name (default: 'btnClick')
+     */
+    static handleButtonClick(router: Router, config: any, primaryUrlKey?: string, primaryClickKey?: string): void;
+    /**
+     * Handles secondary button click actions
+     * @param router - Angular Router instance
+     * @param config - Button configuration object
+     */
+    static handleSecondaryButtonClick(router: Router, config: any): void;
+    /**
+     * Validates if a URL string is properly formatted
+     * @param url - URL to validate
+     * @returns True if URL is valid
+     */
+    static isValidUrl(url: string): boolean;
+    /**
+     * Safely encodes URL parameters
+     * @param value - Value to encode
+     * @returns Encoded string
+     */
+    static encodeParam(value: any): string;
+}

package/lib/helpers/validation.helper.d.ts

@@ -0,0 +1,73 @@
+/**
+ * Centralized validation utility helper for common validation tasks.
+ * Provides reusable validation functions to avoid code duplication.
+ */
+export declare class ValidationHelper {
+    /**
+     * Checks if a value is not null, undefined, or empty string
+     * @param value - Value to check
+     * @returns True if value has content
+     */
+    static hasValue(value: any): boolean;
+    /**
+     * Checks if any values in an object are non-empty
+     * @param obj - Object to check
+     * @returns True if any value is non-empty
+     */
+    static hasNonEmptyValue(obj: any): boolean;
+    /**
+     * Checks if a form has any non-empty values
+     * @param formData - Form data object
+     * @returns True if form has any data
+     */
+    static hasFormData(formData: any): boolean;
+    /**
+     * Validates if an array has items
+     * @param array - Array to check
+     * @returns True if array exists and has items
+     */
+    static hasItems(array: any[]): boolean;
+    /**
+     * Checks if a URL is valid
+     * @param url - URL string to validate
+     * @returns True if URL is valid
+     */
+    static isValidUrl(url: string): boolean;
+    /**
+     * Validates if a string is a valid number
+     * @param value - Value to check
+     * @returns True if value is a valid number
+     */
+    static isValidNumber(value: any): boolean;
+    /**
+     * Checks if an object has a specific property with a valid value
+     * @param obj - Object to check
+     * @param property - Property name
+     * @returns True if property exists and has a value
+     */
+    static hasProperty(obj: any, property: string): boolean;
+    /**
+     * Validates if a selection model row has the required key
+     * @param row - Row object
+     * @param keyName - Key property name
+     * @returns True if row has the key property with a value
+     */
+    static hasRowKey(row: any, keyName: string): boolean;
+    /**
+     * Checks if a filter value should be processed (not null, empty, or invalid)
+     * @param value - Filter value
+     * @returns True if filter value is valid for processing
+     */
+    static isValidFilterValue(value: any): boolean;
+    /**
+     * Validates pagination parameters
+     * @param pageIndex - Page index
+     * @param pageSize - Page size
+     * @returns Object with validation results
+     */
+    static validatePagination(pageIndex: any, pageSize: any): {
+        isValid: boolean;
+        pageIndex: number;
+        pageSize: number;
+    };
+}

package/lib/tis-smart-table-viewer.module.d.ts

@@ -32,6 +32,6 @@ import * as i30 from "@angular/material/sort";
 import * as i31 from "@angular/cdk/drag-drop";
 export declare class TisSmartTableViewerModule {
     static ɵfac: i0.ɵɵFactoryDeclaration<TisSmartTableViewerModule, never>;
-    static ɵmod: i0.ɵɵNgModuleDeclaration<TisSmartTableViewerModule, [typeof i1.ScrollingDirective, typeof i2.TisDatePipe, typeof i3.TisDateTimePipe, typeof i4.TisDateTimeWithSecondsPipe, typeof i5.Quantity, typeof i6.Money, typeof i7.TisSmartTableViewerComponent, typeof i8.TisColumnsBtnComponent, typeof i9.CreateColumnsTemplateComponent, typeof i7.TisSmartTableViewerComponent, typeof i10.TisSmartTableErrorDialogComponent, typeof i11.TisSmartTableConfirmationDialogComponent], [typeof i12.CommonModule, typeof i13.FormsModule, typeof i13.ReactiveFormsModule, typeof i14.RouterLink, typeof i14.RouterOutlet, typeof i15.MatTooltipModule, typeof i16.MatIconModule, typeof i17.MatFormFieldModule, typeof i18.MatSelectModule, typeof i19.MatInputModule, typeof i20.MatSnackBarModule, typeof i21.MatProgressSpinnerModule, typeof i22.MatButtonModule, typeof i23.MatPaginatorModule, typeof i24.LayoutModule, typeof i25.MatDialogModule, typeof i26.MatTableModule, typeof i27.MatCheckboxModule, typeof i28.MatMenuModule, typeof i29.MatDividerModule, typeof i30.MatSortModule, typeof i31.DragDropModule], [typeof i7.TisSmartTableViewerComponent]>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<TisSmartTableViewerModule, [typeof i1.ScrollingDirective, typeof i2.TisDatePipe, typeof i3.TisDateTimePipe, typeof i4.TisDateTimeWithSecondsPipe, typeof i5.Quantity, typeof i6.Money, typeof i7.TisSmartTableViewerComponent, typeof i8.TisColumnsBtnComponent, typeof i9.CreateColumnsTemplateComponent, typeof i10.TisSmartTableErrorDialogComponent, typeof i11.TisSmartTableConfirmationDialogComponent], [typeof i12.CommonModule, typeof i13.FormsModule, typeof i13.ReactiveFormsModule, typeof i14.RouterLink, typeof i14.RouterOutlet, typeof i15.MatTooltipModule, typeof i16.MatIconModule, typeof i17.MatFormFieldModule, typeof i18.MatSelectModule, typeof i19.MatInputModule, typeof i20.MatSnackBarModule, typeof i21.MatProgressSpinnerModule, typeof i22.MatButtonModule, typeof i23.MatPaginatorModule, typeof i24.LayoutModule, typeof i25.MatDialogModule, typeof i26.MatTableModule, typeof i27.MatCheckboxModule, typeof i28.MatMenuModule, typeof i29.MatDividerModule, typeof i30.MatSortModule, typeof i31.DragDropModule], [typeof i7.TisSmartTableViewerComponent]>;
     static ɵinj: i0.ɵɵInjectorDeclaration<TisSmartTableViewerModule>;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@servicemind.tis/tis-smart-table-viewer",
-  "version": "2.2.0",
+  "version": "2.3.1",
   "peerDependencies": {
     "@angular/common": "^19.2.0",
     "@angular/core": "^19.2.0",