ngx-kit 8.3.9 → 8.4.0

package/types/ngx-kit-data-table.d.ts

@@ -1,5 +1,5 @@
 import * as _angular_core from '@angular/core';
-import { InputSignal, Type, TemplateRef, InjectionToken, EnvironmentProviders, OnInit, AfterContentInit } from '@angular/core';
+import { InputSignal, Type, TemplateRef, InjectionToken, EnvironmentProviders, OnInit, AfterContentInit, ElementRef } from '@angular/core';
 import * as ngx_kit_core from 'ngx-kit/core';
 import * as ngx_kit_data_table from 'ngx-kit/data-table';
 
@@ -9,6 +9,42 @@ interface SortMeta<T> {
     direction: SortDirection;
 }
 
+declare enum DynamicDataFilterOperator {
+    Equal = 0,
+    NotEqual = 1,
+    Contains = 2,
+    StartsWith = 3,
+    EndsWith = 4,
+    GreaterThan = 5,
+    GreaterThanOrEqual = 6,
+    LessThan = 7,
+    LessThanOrEqual = 8,
+    Between = 9,
+    In = 10,
+    IsNull = 11,
+    IsNotNull = 12,
+    IsEmpty = 13,
+    IsNotEmpty = 14
+}
+type FilterDataType = 'text' | 'number' | 'date' | 'boolean' | 'enum';
+interface EnumFilterOption<T = unknown> {
+    label: string;
+    value: T;
+}
+interface ColumnFilterConfig<T = unknown> {
+    type?: FilterDataType;
+    enabled?: boolean;
+    options?: EnumFilterOption<T>[];
+    placeholder?: string;
+    defaultOperator?: DynamicDataFilterOperator;
+}
+interface ColumnFilterState {
+    field: string;
+    operator: DynamicDataFilterOperator;
+    value: unknown;
+    valueTo?: unknown;
+}
+
 interface PageEvent {
     page: number;
     pageSize: number;
@@ -16,13 +52,12 @@ interface PageEvent {
 interface PageState {
     pageIndex: number;
     pageSize: number;
-    /** آفست صفر-پایه‌ی اولین ردیف صفحه‌ی جاری. */
     first: number;
 }
-/** هر بار سرور باید صفحه‌ی جدید را (در حالت lazy) واکشی کند، امیت می‌شود. */
 interface LazyLoadEvent<T> extends PageState {
     sorts?: SortMeta<T>[];
     sorting?: string;
+    filters?: ColumnFilterState[];
 }
 
 interface NgxPaginationOptions {
@@ -57,7 +92,7 @@ interface CellTemplateContext<T extends object> {
     field: TableFieldBase<T>;
 }
 /** شکل پایه‌ای مشترک بین همه‌ی ستون‌ها، صرف‌نظر از این‌که renderer دارند یا نه. */
-interface TableFieldBase<T extends object> {
+interface TableFieldBase<T extends object, K extends keyof T = keyof T> {
     column: Extract<keyof T, string>;
     title: string;
     /**
@@ -76,6 +111,8 @@ interface TableFieldBase<T extends object> {
     align?: ColumnAlign;
     prefix?: string;
     formatter?: string | TableCellFormatter<T>;
+    filterable?: boolean;
+    filterConfig?: ColumnFilterConfig<T[K]>;
 }
 /** ستون بدون renderer (متن ساده / formatter / cellTemplate دستی). */
 interface PlainTableField<T extends object> extends TableFieldBase<T> {
@@ -140,6 +177,29 @@ declare class TableLocalization {
     noData: string;
     loading: string;
     operation: string;
+    filter: string;
+    clearFilter: string;
+    applyFilter: string;
+    search: string;
+    selectAll: string;
+    from: string;
+    to: string;
+    trueText: string;
+    falseText: string;
+    opEqual: string;
+    opNotEqual: string;
+    opContains: string;
+    opStartsWith: string;
+    opEndsWith: string;
+    opGreaterThan: string;
+    opGreaterThanOrEqual: string;
+    opLessThan: string;
+    opLessThanOrEqual: string;
+    opBetween: string;
+    opIsNull: string;
+    opIsNotNull: string;
+    opIsEmpty: string;
+    opIsNotEmpty: string;
 }
 
 declare const NGX_TABLE_CONFIG: InjectionToken<ResolvedTableOptions>;
@@ -229,24 +289,19 @@ declare class ColumnResize {
     static ɵdir: _angular_core.ɵɵDirectiveDeclaration<ColumnResize, "[ngxColumnResize]", never, { "startWidth": { "alias": "ngxColumnResizeWidth"; "required": true; "isSignal": true; }; "minWidth": { "alias": "ngxColumnResizeMin"; "required": false; "isSignal": true; }; "maxWidth": { "alias": "ngxColumnResizeMax"; "required": false; "isSignal": true; }; "direction": { "alias": "ngxColumnResizeDir"; "required": false; "isSignal": true; }; }, { "resizing": "resizing"; "resizeEnd": "resizeEnd"; }, never, never, true, never>;
 }
 
-/**
- * جدول داده‌ی جنریک و Type-Safe.
- *
- * `T` از روی چیزی که به [data] بایند می‌کنید استنتاج می‌شود؛ `field.column` در
- * `TableField<T, R>` محدود به `keyof T` است، و اگر از defineFields(renderers, ...)
- * استفاده کنید، `field.renderer` محدود به کلیدهای رجیستری و `rendererInputs`
- * دقیقاً همان ورودی‌های اضافه‌ی همان renderer است.
- *
- * دو حالت:
- *  - کلاینت‌ساید (پیش‌فرض): [data] کل آرایه است؛ سورت/صفحه‌بندی داخلی و روی
- *    یک computed خالص انجام می‌شود (بدون mutation روی آبجکت‌های شما).
- *  - lazy: [lazy]="true" + [totalRecords]؛ [data] فقط صفحه‌ی جاری است؛ به
- *    (lazyLoad) گوش بدهید.
- */
+declare class ColumnFilterService {
+    applyFilters<T>(data: readonly T[], filters: Record<string, ColumnFilterState>): T[];
+    isFilterActive(filter?: ColumnFilterState | null): boolean;
+    private evaluateFilter;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<ColumnFilterService, never>;
+    static ɵprov: _angular_core.ɵɵInjectableDeclaration<ColumnFilterService>;
+}
+
 declare class NgxTable<T extends object> implements OnInit, AfterContentInit {
     protected readonly config: ngx_kit_data_table.ResolvedTableOptions;
     protected readonly labels: ngx_kit_data_table.TableLocalization;
     protected readonly paginationConfig: ngx_kit_data_table.NgxPaginationOptions;
+    protected readonly columnFilterService: ColumnFilterService;
     readonly fields: _angular_core.InputSignal<TableField<T, any>[]>;
     readonly data: _angular_core.InputSignal<readonly T[]>;
     readonly totalRecords: _angular_core.InputSignal<number>;
@@ -264,8 +319,6 @@ declare class NgxTable<T extends object> implements OnInit, AfterContentInit {
     readonly lazy: _angular_core.InputSignal<boolean>;
     readonly resizable: _angular_core.InputSignal<boolean>;
     readonly height: _angular_core.InputSignal<string>;
-    /** پیش‌فرض بر اساس ایندکس؛ برای جلوگیری از گم‌شدن state سطرها هنگام سورت،
-     *  یک شناسه‌ی یکتا بدهید: [trackBy]="(i, row) => row.id" */
     readonly trackBy: _angular_core.InputSignal<(index: number, row: T) => unknown>;
     readonly lazyLoad: _angular_core.OutputEmitterRef<LazyLoadEvent<T>>;
     readonly sortChange: _angular_core.OutputEmitterRef<SortMeta<T>[]>;
@@ -273,10 +326,13 @@ declare class NgxTable<T extends object> implements OnInit, AfterContentInit {
         field: string;
         width: number;
     }>;
+    readonly filterChange: _angular_core.OutputEmitterRef<ColumnFilterState[]>;
+    readonly elementRef: ElementRef<HTMLElement>;
     protected readonly pageIndex: _angular_core.WritableSignal<number>;
     protected readonly pageSizeS: _angular_core.WritableSignal<number>;
     protected readonly sorts: _angular_core.WritableSignal<SortMeta<T>[]>;
     protected readonly widths: _angular_core.WritableSignal<Record<string, number>>;
+    protected readonly activeFilters: _angular_core.WritableSignal<Record<string, ColumnFilterState>>;
     private readonly manuallyResized;
     private readonly rendererInputsCache;
     private cellTemplates;
@@ -289,23 +345,22 @@ declare class NgxTable<T extends object> implements OnInit, AfterContentInit {
     ngOnInit(): void;
     ngAfterContentInit(): void;
     private syncTemplateMap;
+    protected readonly filteredData: _angular_core.Signal<readonly T[]>;
     protected readonly sortedData: _angular_core.Signal<readonly T[]>;
     protected readonly totalCount: _angular_core.Signal<number>;
     protected readonly pagedData: _angular_core.Signal<readonly T[]>;
     private compare;
-    /** بدون mutation روی داده‌ی ورودی: شماره‌ی ردیف صرفاً از روی page/pageSize/rowIndex محاسبه می‌شود. */
     protected recordNumber(rowIndex: number): number;
     protected sortDirectionFor(column: string): SortDirection | null;
     protected onHeaderClick(field: TableField<T, any>, event: MouseEvent): void;
+    protected isFilterable(field: TableField<T, any>): boolean;
+    protected getFilterState(column: string): ColumnFilterState | null;
+    protected getDistinctValues(column: string): unknown[];
+    protected onFilterApply(state: ColumnFilterState): void;
+    protected onFilterClear(field: string): void;
     protected onPaginate(event: PageEvent): void;
     private emitLazyIfNeeded;
     protected columnWidth(column: string): number;
-    /**
-     * مقدار CSS `flex` واقعیِ این ستون:
-     *  - اگه دستی ریسایز شده یا width عددی داره → `0 0 <px>` (ثابت، بدون رشد/کوچک‌شدن)
-     *  - اگه width رشته‌ای داره (مثلاً '20%') → `0 0 <رشته>` (ثابت، هر واحد CSS معتبری)
-     *  - اگه اصلاً width نداره → `1 1 0` (رشد می‌کنه تا فضای باقی‌مونده‌ی جدول رو پر کنه)
-     */
     protected columnFlex(field: TableField<T, any>): string;
     protected columnMin(field: TableField<T, any>): number;
     protected columnMax(field: TableField<T, any>): number;
@@ -317,12 +372,9 @@ declare class NgxTable<T extends object> implements OnInit, AfterContentInit {
     protected getCellValue(row: T, field: TableField<T, any>): unknown;
     protected formatCellValue(row: T, field: TableField<T, any>): string;
     private stringify;
-    /** ورودی‌های renderer را به‌ازای هر (field, row) کش می‌کند تا هر Change
-     *  Detection یک آبجکت جدید ساخته نشود؛ با WeakMap، وقتی row از حافظه خارج
-     *  شود (مثلاً بعد از عوض‌شدن صفحه)، entry آن هم خودکار پاک می‌شود. */
     protected getRendererInputs(row: T, field: TableField<T, any>): Record<string, unknown>;
     static ɵfac: _angular_core.ɵɵFactoryDeclaration<NgxTable<any>, never>;
-    static ɵcmp: _angular_core.ɵɵComponentDeclaration<NgxTable<any>, "ngx-table", never, { "fields": { "alias": "fields"; "required": true; "isSignal": true; }; "data": { "alias": "data"; "required": true; "isSignal": true; }; "totalRecords": { "alias": "totalRecords"; "required": true; "isSignal": true; }; "showRecordNumber": { "alias": "showRecordNumber"; "required": false; "isSignal": true; }; "operations": { "alias": "operations"; "required": false; "isSignal": true; }; "operationWidth": { "alias": "operationWidth"; "required": false; "isSignal": true; }; "numWidth": { "alias": "numWidth"; "required": false; "isSignal": true; }; "pageSize": { "alias": "pageSize"; "required": false; "isSignal": true; }; "page": { "alias": "page"; "required": false; "isSignal": true; }; "loading": { "alias": "loading"; "required": false; "isSignal": true; }; "multiSort": { "alias": "multiSort"; "required": false; "isSignal": true; }; "lazy": { "alias": "lazy"; "required": false; "isSignal": true; }; "resizable": { "alias": "resizable"; "required": false; "isSignal": true; }; "height": { "alias": "height"; "required": false; "isSignal": true; }; "trackBy": { "alias": "trackBy"; "required": false; "isSignal": true; }; }, { "pageChange": "pageChange"; "lazyLoad": "lazyLoad"; "sortChange": "sortChange"; "columnResize": "columnResize"; }, ["cellTemplates"], never, true, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<NgxTable<any>, "ngx-table", never, { "fields": { "alias": "fields"; "required": true; "isSignal": true; }; "data": { "alias": "data"; "required": true; "isSignal": true; }; "totalRecords": { "alias": "totalRecords"; "required": true; "isSignal": true; }; "showRecordNumber": { "alias": "showRecordNumber"; "required": false; "isSignal": true; }; "operations": { "alias": "operations"; "required": false; "isSignal": true; }; "operationWidth": { "alias": "operationWidth"; "required": false; "isSignal": true; }; "numWidth": { "alias": "numWidth"; "required": false; "isSignal": true; }; "pageSize": { "alias": "pageSize"; "required": false; "isSignal": true; }; "page": { "alias": "page"; "required": false; "isSignal": true; }; "loading": { "alias": "loading"; "required": false; "isSignal": true; }; "multiSort": { "alias": "multiSort"; "required": false; "isSignal": true; }; "lazy": { "alias": "lazy"; "required": false; "isSignal": true; }; "resizable": { "alias": "resizable"; "required": false; "isSignal": true; }; "height": { "alias": "height"; "required": false; "isSignal": true; }; "trackBy": { "alias": "trackBy"; "required": false; "isSignal": true; }; }, { "pageChange": "pageChange"; "lazyLoad": "lazyLoad"; "sortChange": "sortChange"; "columnResize": "columnResize"; "filterChange": "filterChange"; }, ["cellTemplates"], never, true, never>;
 }
 
 declare class NgxPagination {
@@ -351,5 +403,42 @@ declare class NgxPagination {
     static ɵcmp: _angular_core.ɵɵComponentDeclaration<NgxPagination, "ngx-pagination", never, { "total": { "alias": "total"; "required": true; "isSignal": true; }; "page": { "alias": "page"; "required": false; "isSignal": true; }; "pageSize": { "alias": "pageSize"; "required": false; "isSignal": true; }; "pageSizeOptions": { "alias": "pageSizeOptions"; "required": false; "isSignal": true; }; "siblingCount": { "alias": "siblingCount"; "required": false; "isSignal": true; }; "boundaryCount": { "alias": "boundaryCount"; "required": false; "isSignal": true; }; }, { "page": "pageChange"; "pageSize": "pageSizeChange"; "paginate": "paginate"; }, never, never, true, never>;
 }
 
-export { ColumnResize, NGX_PAGINATION_CONFIG, NGX_PAGINATION_I18N, NGX_TABLE_CONFIG, NGX_TABLE_I18N, NgxPagination, NgxTable, PaginationLocalization, TableCell, TableLocalization, defineFields, defineRenderers, providePagination, provideTable };
-export type { CellRendererComponent, CellTemplateContext, ColumnAlign, ColumnSizingConfig, LazyLoadEvent, NgxPaginationOptions, NgxTableOptions, PageEvent, PageState, PlainTableField, RenderedTableField, RendererExtraInputs, RendererRegistry, ResolvedTableOptions, SortDirection, SortMeta, TableCellFormatter, TableField, TableFieldBase };
+declare class NgxColumnFilter {
+    protected readonly labels: ngx_kit_data_table.TableLocalization;
+    private readonly elementRef;
+    readonly tableEl: _angular_core.InputSignal<ElementRef<HTMLElement>>;
+    readonly field: _angular_core.InputSignal<string>;
+    readonly config: _angular_core.InputSignal<ColumnFilterConfig<unknown> | undefined>;
+    readonly currentFilter: _angular_core.InputSignal<ColumnFilterState | null>;
+    readonly distinctValues: _angular_core.InputSignal<unknown[]>;
+    readonly applyFilter: _angular_core.OutputEmitterRef<ColumnFilterState>;
+    readonly clearFilter: _angular_core.OutputEmitterRef<string>;
+    protected readonly isOpen: _angular_core.WritableSignal<boolean>;
+    protected readonly filterType: _angular_core.Signal<FilterDataType>;
+    protected readonly selectedOperator: _angular_core.WritableSignal<DynamicDataFilterOperator>;
+    protected readonly filterValue: _angular_core.WritableSignal<any>;
+    protected readonly filterValueTo: _angular_core.WritableSignal<any>;
+    protected readonly selectedEnumValues: _angular_core.WritableSignal<Set<any>>;
+    protected readonly enumSearchQuery: _angular_core.WritableSignal<string>;
+    protected readonly operators: _angular_core.Signal<{
+        label: string;
+        value: DynamicDataFilterOperator;
+    }[]>;
+    protected readonly enumOptions: _angular_core.Signal<EnumFilterOption<unknown>[]>;
+    protected readonly filteredEnumOptions: _angular_core.Signal<EnumFilterOption<unknown>[]>;
+    protected readonly isNoValueOperator: _angular_core.Signal<boolean>;
+    protected toggleDropdown(event: MouseEvent): void;
+    updatePosition(): void;
+    private syncStateFromInput;
+    protected onApply(): void;
+    protected onClear(): void;
+    protected toggleEnumSelection(val: any): void;
+    protected toggleSelectAll(checked: boolean): void;
+    protected onDocumentClick(event: MouseEvent): void;
+    protected onEscape(): void;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<NgxColumnFilter, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<NgxColumnFilter, "ngx-column-filter", never, { "tableEl": { "alias": "tableEl"; "required": true; "isSignal": true; }; "field": { "alias": "field"; "required": true; "isSignal": true; }; "config": { "alias": "config"; "required": false; "isSignal": true; }; "currentFilter": { "alias": "currentFilter"; "required": false; "isSignal": true; }; "distinctValues": { "alias": "distinctValues"; "required": false; "isSignal": true; }; }, { "applyFilter": "applyFilter"; "clearFilter": "clearFilter"; }, never, never, true, never>;
+}
+
+export { ColumnFilterService, ColumnResize, DynamicDataFilterOperator, NGX_PAGINATION_CONFIG, NGX_PAGINATION_I18N, NGX_TABLE_CONFIG, NGX_TABLE_I18N, NgxColumnFilter, NgxPagination, NgxTable, PaginationLocalization, TableCell, TableLocalization, defineFields, defineRenderers, providePagination, provideTable };
+export type { CellRendererComponent, CellTemplateContext, ColumnAlign, ColumnFilterConfig, ColumnFilterState, ColumnSizingConfig, EnumFilterOption, FilterDataType, LazyLoadEvent, NgxPaginationOptions, NgxTableOptions, PageEvent, PageState, PlainTableField, RenderedTableField, RendererExtraInputs, RendererRegistry, ResolvedTableOptions, SortDirection, SortMeta, TableCellFormatter, TableField, TableFieldBase };