@mediusinc/mng-commons 5.3.0-rc.3 → 5.3.0-rc.4

package/filter/descriptors/filter-lookup.descriptor.d.ts

@@ -2,21 +2,21 @@ import { ClassType, EnumConstantType, EnumValue, FilterMatchModeExtendedType, IL
 import { EnumDescriptor } from '@mediusinc/mng-commons/model';
 import { FilterLookupTypeEnum } from '../models/filter.model';
 import { FilterDescriptor } from './filter.descriptor';
-export type FilterLookupDescriptorConstructorOptsType<FilterModel, Service> = FilterLookupDescriptorCreateOptsProviderType<FilterModel, Service> & {
+export type FilterLookupDescriptorConstructorOptsType<FilterModel, Service, Sorts = keyof FilterModel, Filters extends keyof any = keyof FilterModel> = FilterLookupDescriptorCreateOptsProviderType<FilterModel, Service, Sorts, Filters> & {
     type?: ClassType<FilterModel>;
     optionsValueProperty?: string | null;
 };
-export type FilterLookupDescriptorCreateOptsProviderType<FilterModel, Service> = {
+export type FilterLookupDescriptorCreateOptsProviderType<FilterModel, Service, Sorts = keyof FilterModel, Filters extends keyof any = keyof FilterModel> = {
     serviceType?: ServiceClassType<Service>;
-    dataProvider?: ILookupDataProvider<FilterModel, Service>;
+    dataProvider?: ILookupDataProvider<FilterModel, Service, Sorts, Filters>;
 };
 export type FilterLookupAutocompleteOptsType = {
     openOnFocus?: boolean;
     inlineSearch?: boolean;
     autoClear?: boolean;
 };
-export declare class FilterLookupDescriptor<FilterModel, TableModel, Service = any> extends FilterDescriptor<FilterModel, TableModel> implements ILookupDescriptor<FilterModel> {
-    protected readonly _dataProvider: ILookupDataProvider<FilterModel, Service>;
+export declare class FilterLookupDescriptor<FilterModel, TableModel, Service = any, Sorts = keyof FilterModel, Filters extends keyof any = keyof FilterModel> extends FilterDescriptor<FilterModel, TableModel> implements ILookupDescriptor<FilterModel, Service, Sorts, Filters> {
+    protected readonly _dataProvider: ILookupDataProvider<FilterModel, Service, Sorts, Filters>;
     protected readonly _optionsValueProperty?: string | null;
     protected _lookupType?: FilterLookupTypeEnum;
     protected _optionsLabelProperty?: string;
@@ -26,9 +26,9 @@ export declare class FilterLookupDescriptor<FilterModel, TableModel, Service = a
     protected _autocompleteOpenOnFocus?: boolean;
     protected _autocompleteInlineSearch?: boolean;
     protected _autocompleteAutoClear?: boolean;
-    constructor(property: string, cfg?: FilterLookupDescriptorConstructorOptsType<FilterModel, Service>);
+    constructor(property: string, cfg?: FilterLookupDescriptorConstructorOptsType<FilterModel, Service, Sorts, Filters>);
     get lookupType(): FilterLookupTypeEnum | undefined;
-    get dataProvider(): ILookupDataProvider<FilterModel, Service>;
+    get dataProvider(): ILookupDataProvider<FilterModel, Service, Sorts, Filters>;
     get optionsLabelProperty(): string | undefined;
     get optionsLabelTranslate(): boolean;
     get optionsValueProperty(): string | undefined;
@@ -37,31 +37,89 @@ export declare class FilterLookupDescriptor<FilterModel, TableModel, Service = a
     get autocompleteAutoClear(): boolean | undefined;
     get autocompleteInlineSearch(): boolean | undefined;
     get dropdownClassName(): string;
+    /**
+     * Sets label property for options display.
+     *
+     * @param property Property for label options.
+     * @param translate If the options should be translated through the i18n.
+     */
     withOptionsLabelProperty(property: keyof FilterModel, translate?: boolean): this;
+    /**
+     * Sets label property for options display.
+     *
+     * This function is UNSAFE!
+     *
+     * @param property Property for label options.
+     * @param translate If the options should be translated through the i18n.
+     */
     withOptionsLabelPropertyUnsafe(property: string, translate?: boolean): this;
     /**
      * Method will set `optionsValueProperty`, because track properties are not supported here as filters need final value to work correctly.
-     * Use `optionsValueProperty` instead.
+     * Use `optionsValueProperty` in filter creation instead.
      */
     withOptionsTrackProperty(): this;
+    /**
+     * Method will set `optionsValueProperty`, because track properties are not supported here as filters need final value to work correctly.
+     * Use `optionsValueProperty` in filter creation instead.
+     */
     withOptionsTrackPropertyUnsafe(): this;
-    withLookup(lookup?: LookupDataProviderLookupFnType<FilterModel, Service>): this;
+    withLookup(lookup?: LookupDataProviderLookupFnType<FilterModel, Service, Sorts, Filters>): this;
+    /**
+     * Sets multiselect for lookups.
+     *
+     * @param multiselect Enables/disables the feature.
+     */
     withMultiselect(multiselect?: boolean): this;
+    /**
+     * Sets the dropdown class name.
+     * @param dropdownClassName Class name for dropdown.
+     */
     withDropdownClassName(dropdownClassName: string): this;
+    /**
+     * Sets default filter value for filter.
+     *
+     * @param value Value for default filter.
+     * @param matchMode Match mode for default filter.
+     */
     withDefaultFilter(value: FilterModel | FilterModel[] | undefined, matchMode: FilterMatchModeExtendedType): this;
+    /**
+     * Sets lookup as autocomplete instead of dropdown.
+     *
+     * @param opts Additional options.
+     */
     asAutocomplete(opts?: FilterLookupAutocompleteOptsType): this;
-    copy(): FilterLookupDescriptor<FilterModel, TableModel, Service>;
-    protected copyFieldsTo(filter: FilterLookupDescriptor<FilterModel, TableModel, Service>): void;
+    /**
+     * Copies current descriptor to a new instance.
+     */
+    copy(): FilterLookupDescriptor<FilterModel, TableModel, Service, Sorts, Filters>;
+    protected copyFieldsTo(filter: FilterLookupDescriptor<FilterModel, TableModel, Service, Sorts, Filters>): void;
 }
-export declare class FilterLookupEnumDescriptor<Enum, TableModel> extends FilterLookupDescriptor<EnumValue, TableModel> {
+export declare class FilterLookupEnumDescriptor<Enum, TableModel> extends FilterLookupDescriptor<EnumValue, TableModel, undefined, never, never> {
     private readonly _enum;
     private readonly _optionEnumValues;
     private readonly _nameAsValue;
     constructor(property: string, enumDesc: EnumDescriptor<Enum>, options?: Array<Enum>);
     get enum(): EnumDescriptor<Enum>;
+    /**
+     * Sets lookup as autocomplete instead of dropdown.
+     *
+     * @param opts Additional options.
+     */
     asAutocomplete(opts?: FilterLookupAutocompleteOptsType): this;
     withMultiselectEnum(multiselect?: boolean): FilterLookupEnumDescriptor<Enum, TableModel>;
+    /**
+     * Do not use, use `withDefaultFilterEnum` instead.
+     */
     withDefaultFilter(): this;
+    /**
+     * Sets default filter value for filter.
+     *
+     * @param value Value(s) for default filter.
+     * @param matchMode Match mode for default filter.
+     */
     withDefaultFilterEnum(value: EnumConstantType | EnumConstantType[] | undefined, matchMode: FilterMatchModeExtendedType): this;
+    /**
+     * Copies current descriptor to a new instance.
+     */
     copy(): FilterLookupEnumDescriptor<Enum, TableModel>;
 }

package/filter/descriptors/filter.descriptor.d.ts

@@ -33,7 +33,7 @@ export declare class FilterDescriptor<FilterModel, TableModel> implements IFilte
     protected _hasDefaultValue: boolean;
     protected _defaultMatchMode?: FilterMatchModeExtendedType;
     protected _defaultValue?: FilterModel | FilterModel[];
-    protected _matchModes: string[] | null;
+    protected _matchModes?: string[];
     private _displayFormat?;
     private _displayFormatApplyToField?;
     private _locale?;
@@ -60,7 +60,7 @@ export declare class FilterDescriptor<FilterModel, TableModel> implements IFilte
     get hasDefaultValue(): boolean;
     get defaultValue(): FilterModel | FilterModel[] | undefined;
     get defaultMatchMode(): string | undefined;
-    get matchModes(): string[] | null;
+    get matchModes(): string[] | undefined;
     get displayFormat(): string | undefined;
     get displayFormatApplyToField(): boolean | undefined;
     get locale(): string | undefined;
@@ -81,31 +81,142 @@ export declare class FilterDescriptor<FilterModel, TableModel> implements IFilte
     get trimOption(): InputTrimType | undefined;
     get property(): string;
     get title(): string | undefined;
+    /**
+     * Converts filter to given type.
+     *
+     * @param filterType Filter type.
+     */
     asFilterType(filterType: FilterTypeEnum): this;
+    /**
+     * Set filter as date type.
+     *
+     * @param opts Additional options.
+     */
     asDate(opts?: FilterDateOptsType): this;
+    /**
+     * Set filter as number type.
+     *
+     * @param opts Additional options.
+     */
     asNumber(opts?: FilterNumberOptsType): this;
+    /**
+     * Shows filter on column for given property.
+     *
+     * @param property Column property to show filter on.
+     * @param displayType Optional display type override. If not column, the filter will not be shown on column.
+     */
     withShowOnColumn(property: keyof TableModel, displayType?: FilterDisplayTypeEnum | undefined): this;
-    withDisplayType(type?: FilterDisplayTypeEnum): this;
+    /**
+     * Shows filter on column for given property.
+     *
+     * This function is UNSAFE.
+     *
+     * @param property Column property to show filter on.
+     * @param displayType Optional display type override. If not column, the filter will not be shown on column.
+     */
     withShowOnColumnUnsafe(property: string, displayType?: FilterDisplayTypeEnum | undefined): this;
+    /**
+     * Changes display type of filter.
+     *
+     * @param type Display type.
+     */
+    withDisplayType(type?: FilterDisplayTypeEnum): this;
+    /**
+     * Sets default filter value for filter.
+     *
+     * @param value Value for default filter.
+     * @param matchMode Match mode for default filter.
+     */
     withDefaultFilter(value: FilterModel | FilterModel[] | undefined, matchMode: FilterMatchModeExtendedType): this;
     protected validateDefaultFilter(value: FilterModel | FilterModel[] | undefined, matchMode: FilterMatchModeExtendedType): void;
+    /**
+     * Sets format for display of filter value (applies to date and number).
+     *
+     * @param format Format (Angular formatting rules apply).
+     * @param applyToField If the format should also be applied to field on filter editing form.
+     */
     withDisplayFormat(format?: string, applyToField?: boolean): this;
+    /**
+     * Sets locale for filter.
+     *
+     * @param locale Locale.
+     */
     withLocale(locale?: string): this;
+    /**
+     * Sets fraction for number filter editing field.
+     *
+     * @param min Min fraction digits (i.e. digits after decimal).
+     * @param max Max fraction digits (i.e. digits after decimal).
+     */
     withNumberFractions(min?: number, max?: number): this;
+    /**
+     * If number grouping should be used.
+     *
+     * @param useGrouping Enables/disbaled the feature.
+     */
     withNumberGrouping(useGrouping?: boolean): this;
     /**
      * @deprecated Use ${withDatePickerDisplay} instead.
      */
     withDateFormat(format?: string, showTime?: boolean, showSeconds?: boolean): this;
+    /**
+     * Sets date picker display options.
+     *
+     * @param opts Options.
+     */
     withDatePickerDisplay(opts?: FilterDatePickerDisplayOptsType): this;
+    /**
+     * Sets filter date value formatting options.
+     *
+     * @param opts Options.
+     */
     withDateValue(opts?: FilterDateValueOptsType): this;
+    /**
+     * Sets placeholder for filter field.
+     *
+     * @param placeholder Text for placeholder.
+     */
     withPlaceholder(placeholder: string): this;
+    /**
+     * Sets class name for filter.
+     *
+     * @param className Class name.
+     */
     withClassName(className: string): this;
+    /**
+     * Sets class name for column display type.
+     *
+     * @param className Class name for column.
+     */
     withColumnClassName(className: string): this;
+    /**
+     * Set column width for column display type.
+     *
+     * @param width Relative width (in percentage) of table width:
+     * @param minWidth
+     */
     withColumnWidth(width?: number, minWidth?: number): this;
+    /**
+     * Sets input trimming for filter value field.
+     *
+     * @param trimOption Trim setting.
+     */
     withInputTrimming(trimOption?: InputTrimType): this;
-    withMatchModes(matchModes: Array<FilterMatchModeExtendedType>): this;
-    withTitle(key: string): this;
+    /**
+     * Sets range of match modes for this filter. If non provided, the defaults are applied.
+     *
+     * @param matchModes Match mode options.
+     */
+    withMatchModes(matchModes?: Array<FilterMatchModeExtendedType>): this;
+    /**
+     * Filter title. If non provided, the defaults are applied.
+     *
+     * @param title Title for the field.
+     */
+    withTitle(title: string): this;
+    /**
+     * Copies current descriptor to a new instance.
+     */
     copy(): FilterDescriptor<FilterModel, TableModel>;
     protected copyFieldsTo(descriptor: FilterDescriptor<FilterModel, TableModel>): void;
 }

package/form/api/data-providers/lookup-data-provider.factory.d.ts

@@ -3,16 +3,20 @@ import { ModelDescriptor, TypeDescriptor } from '@mediusinc/mng-commons/model';
 import { LookupDataProviderInst } from './lookup.data-provider';
 export declare class LookupDataProvider extends LookupDataProviderInst<any> {
     protected constructor();
-    static create<Model>(): LookupDataProviderInst<Model, undefined, undefined, undefined>;
-    static fromClass<Model>(type: ClassType<Model>): LookupDataProviderInst<Model, undefined, ClassType<Model>, undefined>;
-    static fromClassWithService<Model, Service>(type: ClassType<Model>, serviceType: ServiceClassType<Service>): LookupDataProviderInst<Model, Service, ClassType<Model>, ServiceClassType<Service>>;
-    static fromService<ServiceType, ModelType>(serviceType: ServiceClassType<ServiceType>): LookupDataProviderInst<ModelType, ServiceType, undefined, ServiceClassType<ServiceType>>;
+    static create<Model, Sorts = keyof Model, Filters extends keyof any = keyof Model>(): LookupDataProviderInst<Model, undefined, Sorts, Filters, undefined, undefined>;
+    static fromClass<Model, Sorts = keyof Model, Filters extends keyof any = keyof Model>(type: ClassType<Model>): LookupDataProviderInst<Model, undefined, Sorts, Filters, ClassType<Model>, undefined>;
+    static fromClassWithService<Model, Service, Sorts = keyof Model, Filters extends keyof any = keyof Model>(type: ClassType<Model>, serviceType: ServiceClassType<Service>): LookupDataProviderInst<Model, Service, Sorts, Filters, ClassType<Model>, ServiceClassType<Service>>;
+    static fromService<Service, Model, Sorts = keyof Model, Filters extends keyof any = keyof Model>(serviceType: ServiceClassType<Service>): LookupDataProviderInst<Model, Service, Sorts, Filters, undefined, ServiceClassType<Service>>;
 }
-export declare function lookupDataProvider<Model>(): LookupDataProviderInst<Model, undefined, undefined, undefined>;
-export declare function lookupDataProvider<Model>(type: TypeDescriptor<Model>): LookupDataProviderInst<Model, undefined, undefined, undefined>;
-export declare function lookupDataProvider<Model, Service = any>(type: TypeDescriptor<Model>, serviceType: ServiceClassType<Service>): LookupDataProviderInst<Model, Service, undefined, ServiceClassType<Service>>;
-export declare function lookupDataProviderWithService<Service, Model>(serviceType: ServiceClassType<Service>): LookupDataProviderInst<Model, Service, undefined, ServiceClassType<Service>>;
-export declare function lookupDataProviderFromClass<Model>(type: ClassType<Model>): LookupDataProviderInst<Model, undefined, ClassType<Model>, undefined>;
-export declare function lookupDataProviderFromClass<Model, Service = any>(type: ClassType<Model>, serviceType: ServiceClassType<Service>): LookupDataProviderInst<Model, Service, ClassType<Model>, ServiceClassType<Service>>;
-export declare function lookupDataProviderFromModel<Model, ModelClass = ClassType<Model>>(model: ModelDescriptor<Model, ModelClass>): LookupDataProviderInst<Model, undefined, ModelClass, undefined>;
-export declare function lookupDataProviderFromModel<Model, Service = any, ModelClass = ClassType<Model>>(model: ModelDescriptor<Model, ModelClass>, ServiceClass: ServiceClassType<Service>): LookupDataProviderInst<Model, Service, ModelClass, ServiceClassType<Service>>;
+export type LookupDataProviderCreateOptsType<TableModel, Sorts = keyof TableModel, Filters = keyof TableModel> = {
+    filtersType?: TypeDescriptor<Filters>;
+    sortsType?: TypeDescriptor<Sorts>;
+};
+export declare function lookupDataProvider<Model, Sorts = keyof Model, Filters extends keyof any = keyof Model>(): LookupDataProviderInst<Model, undefined, Sorts, Filters, undefined, undefined>;
+export declare function lookupDataProvider<Model, Sorts = keyof Model, Filters extends keyof any = keyof Model>(type: TypeDescriptor<Model>, opts?: LookupDataProviderCreateOptsType<Model, Sorts, Filters>): LookupDataProviderInst<Model, undefined, Sorts, Filters, undefined, undefined>;
+export declare function lookupDataProvider<Model, Service = any, Sorts = keyof Model, Filters extends keyof any = keyof Model>(type: TypeDescriptor<Model>, serviceType: ServiceClassType<Service>, opts?: LookupDataProviderCreateOptsType<Model, Sorts, Filters>): LookupDataProviderInst<Model, Service, Sorts, Filters, undefined, ServiceClassType<Service>>;
+export declare function lookupDataProviderWithService<Service, Model, Sorts = keyof Model, Filters extends keyof any = keyof Model>(serviceType: ServiceClassType<Service>, opts?: LookupDataProviderCreateOptsType<Model, Sorts, Filters>): LookupDataProviderInst<Model, Service, Sorts, Filters, undefined, ServiceClassType<Service>>;
+export declare function lookupDataProviderFromClass<Model, Sorts = keyof Model, Filters extends keyof any = keyof Model>(type: ClassType<Model>): LookupDataProviderInst<Model, undefined, Sorts, Filters, ClassType<Model>, undefined>;
+export declare function lookupDataProviderFromClass<Model, Service = any, Sorts = keyof Model, Filters extends keyof any = keyof Model>(type: ClassType<Model>, serviceType: ServiceClassType<Service>): LookupDataProviderInst<Model, Service, Sorts, Filters, ClassType<Model>, ServiceClassType<Service>>;
+export declare function lookupDataProviderFromModel<Model, Sorts = keyof Model, Filters extends keyof any = keyof Model, ModelClass = ClassType<Model>>(model: ModelDescriptor<Model, ModelClass>, opts?: LookupDataProviderCreateOptsType<Model, Sorts, Filters>): LookupDataProviderInst<Model, undefined, Sorts, Filters, ModelClass, undefined>;
+export declare function lookupDataProviderFromModel<Model, Sorts = keyof Model, Filters extends keyof any = keyof Model, Service = any, ModelClass = ClassType<Model>>(model: ModelDescriptor<Model, ModelClass>, ServiceClass: ServiceClassType<Service>, opts?: LookupDataProviderCreateOptsType<Model, Sorts, Filters>): LookupDataProviderInst<Model, Service, Sorts, Filters, ModelClass, ServiceClassType<Service>>;

package/form/api/data-providers/lookup.data-provider.d.ts

@@ -1,7 +1,7 @@
 import { ClassOptType, DataProviderInst, ILookupDataProvider, LookupDataProviderLookupFnType, ServiceClassOptType } from '@mediusinc/mng-commons/core';
-export declare class LookupDataProviderInst<ModelType, ServiceType = any, CT = ClassOptType<ModelType>, ST = ServiceClassOptType<ServiceType>> extends DataProviderInst<ModelType, ServiceType, CT, ST> implements ILookupDataProvider<ModelType, ServiceType, CT, ST> {
-    protected _lookup: LookupDataProviderLookupFnType<ModelType, ServiceType>;
-    constructor(type: CT, serviceType: ST);
-    get lookup(): LookupDataProviderLookupFnType<ModelType, ServiceType>;
-    withLookup(fn: LookupDataProviderLookupFnType<ModelType, ServiceType>): this;
+export declare class LookupDataProviderInst<Model, Service = any, Sorts = keyof Model, Filters extends keyof any = keyof Model, ModelClass = ClassOptType<Model>, ServiceClass = ServiceClassOptType<Service>> extends DataProviderInst<Model, Service, ModelClass, ServiceClass> implements ILookupDataProvider<Model, Service, Sorts, Filters, ModelClass, ServiceClass> {
+    protected _lookup: LookupDataProviderLookupFnType<Model, Service, Sorts, Filters>;
+    constructor(type: ModelClass, serviceType: ServiceClass);
+    get lookup(): LookupDataProviderLookupFnType<Model, Service, Sorts, Filters>;
+    withLookup(fn: LookupDataProviderLookupFnType<Model, Service, Sorts, Filters>): this;
 }

package/form/components/autocomplete/autocomplete.component.d.ts

@@ -11,7 +11,7 @@ export declare class AutocompleteComponent implements ControlValueAccessor, OnIn
     private readonly destroyRef;
     private readonly translate;
     private readonly logger;
-    dataProvider: import("@angular/core").InputSignal<ILookupDataProvider<any, any>>;
+    dataProvider: import("@angular/core").InputSignal<ILookupDataProvider<any, any, any, any>>;
     optionsTrackProperty: import("@angular/core").InputSignal<string | undefined>;
     optionsValuePropertyInit: import("@angular/core").InputSignal<string | undefined>;
     optionsLabelPropertyInit: import("@angular/core").InputSignal<string | undefined>;

package/form/components/dropdown/dropdown.component.d.ts

@@ -10,7 +10,7 @@ export declare class DropdownComponent implements ControlValueAccessor {
     private readonly injector;
     private readonly destroyRef;
     private readonly translate;
-    dataProvider: import("@angular/core").InputSignal<ILookupDataProvider<any, any> | undefined>;
+    dataProvider: import("@angular/core").InputSignal<ILookupDataProvider<any, any, any, any> | undefined>;
     options: import("@angular/core").InputSignal<any[]>;
     optionsTrackProperty: import("@angular/core").InputSignal<string | undefined>;
     optionsLabelPropertyInit: import("@angular/core").InputSignal<string | undefined>;

package/model/helpers/model.d.ts

@@ -2,4 +2,4 @@ import { ClassAttributeDef, ClassType, ILookupDescriptor } from '@mediusinc/mng-
 export declare function findClassIdAttribute<T>(classType?: ClassType<T>): string | null;
 export declare function findClassTitleAttribute<T>(classType?: ClassType<T>): string | null;
 export declare function getClassAttributeDef<T>(classType?: ClassType<T>): ClassAttributeDef[] | null;
-export declare function trySetLookupItemsProperties<T>(lookup: ILookupDescriptor<T>, idAsTrack?: boolean): void;
+export declare function trySetLookupItemsProperties<Model>(lookup: ILookupDescriptor<Model, any, any, any>, idAsTrack?: boolean): void;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mediusinc/mng-commons",
-  "version": "5.3.0-rc.3",
+  "version": "5.3.0-rc.4",
   "peerDependencies": {
     "@angular/animations": "^17.3.0 || ^18.0.0",
     "@angular/common": "^17.3.0 || ^18.0.0",

package/table/api/data-providers/table-data-provider.factory.d.ts

@@ -8,11 +8,15 @@ export declare class TableDataProvider extends TableDataProviderInst<any> {
     static fromClassWithService<Model, Service, Sorts = keyof Model, Filters extends keyof any = keyof Model>(type: ClassType<Model>, serviceType: ServiceClassType<Service>): TableDataProviderInst<Model, Service, Sorts, Filters, ClassType<Model>, ServiceClassType<Service>>;
     static fromService<Service, Model, Sorts = keyof Model, Filters extends keyof any = keyof Model>(serviceType: ServiceClassType<Service>): TableDataProviderInst<Model, Service, Sorts, Filters, undefined, ServiceClassType<Service>>;
 }
+export type TableDataProviderCreateOptsType<TableModel, Sorts = keyof TableModel, Filters = keyof TableModel> = {
+    filtersType?: TypeDescriptor<Filters>;
+    sortsType?: TypeDescriptor<Sorts>;
+};
 export declare function tableDataProvider<Model, Sorts = keyof Model, Filters extends keyof any = keyof Model>(): TableDataProviderInst<Model, undefined, Sorts, Filters, undefined, undefined>;
-export declare function tableDataProvider<Model, Sorts = keyof Model, Filters extends keyof any = keyof Model>(type: TypeDescriptor<Model>): TableDataProviderInst<Model, undefined, Sorts, Filters, undefined, undefined>;
-export declare function tableDataProvider<Model, Service = any, Sorts = keyof Model, Filters extends keyof any = keyof Model>(type: TypeDescriptor<Model>, serviceType: ServiceClassType<Service>): TableDataProviderInst<Model, Service, Sorts, Filters, undefined, ServiceClassType<Service>>;
-export declare function tableDataProviderWithService<Service, Model, Sorts = keyof Model, Filters extends keyof any = keyof Model>(serviceType: ServiceClassType<Service>): TableDataProviderInst<Model, Service, Sorts, Filters, undefined, ServiceClassType<Service>>;
+export declare function tableDataProvider<Model, Sorts = keyof Model, Filters extends keyof any = keyof Model>(type: TypeDescriptor<Model>, opts?: TableDataProviderCreateOptsType<Model, Sorts, Filters>): TableDataProviderInst<Model, undefined, Sorts, Filters, undefined, undefined>;
+export declare function tableDataProvider<Model, Service = any, Sorts = keyof Model, Filters extends keyof any = keyof Model>(type: TypeDescriptor<Model>, serviceType: ServiceClassType<Service>, opts?: TableDataProviderCreateOptsType<Model, Sorts, Filters>): TableDataProviderInst<Model, Service, Sorts, Filters, undefined, ServiceClassType<Service>>;
+export declare function tableDataProviderWithService<Service, Model, Sorts = keyof Model, Filters extends keyof any = keyof Model>(serviceType: ServiceClassType<Service>, opts?: TableDataProviderCreateOptsType<Model, Sorts, Filters>): TableDataProviderInst<Model, Service, Sorts, Filters, undefined, ServiceClassType<Service>>;
 export declare function tableDataProviderFromClass<Model, Sorts = keyof Model, Filters extends keyof any = keyof Model>(type: ClassType<Model>): TableDataProviderInst<Model, undefined, Sorts, Filters, ClassType<Model>, undefined>;
 export declare function tableDataProviderFromClass<Model, Service = any, Sorts = keyof Model, Filters extends keyof any = keyof Model>(type: ClassType<Model>, serviceType: ServiceClassType<Service>): TableDataProviderInst<Model, Service, Sorts, Filters, ClassType<Model>, ServiceClassType<Service>>;
-export declare function tableDataProviderFromModel<Model, Sorts = keyof Model, Filters extends keyof any = keyof Model, ModelClass = ClassType<Model>>(model: ModelDescriptor<Model, ModelClass>): TableDataProviderInst<Model, undefined, Sorts, Filters, ModelClass, undefined>;
-export declare function tableDataProviderFromModel<Model, Service = any, Sorts = keyof Model, Filters extends keyof any = keyof Model, ModelClass = ClassType<Model>>(model: ModelDescriptor<Model, ModelClass>, ServiceClass: ServiceClassType<Service>): TableDataProviderInst<Model, Service, Sorts, Filters, ModelClass, ServiceClassType<Service>>;
+export declare function tableDataProviderFromModel<Model, Sorts = keyof Model, Filters extends keyof any = keyof Model, ModelClass = ClassType<Model>>(model: ModelDescriptor<Model, ModelClass>, opts?: TableDataProviderCreateOptsType<Model, Sorts, Filters>): TableDataProviderInst<Model, undefined, Sorts, Filters, ModelClass, undefined>;
+export declare function tableDataProviderFromModel<Model, Service = any, Sorts = keyof Model, Filters extends keyof any = keyof Model, ModelClass = ClassType<Model>>(model: ModelDescriptor<Model, ModelClass>, serviceClass: ServiceClassType<Service>, opts?: TableDataProviderCreateOptsType<Model, Sorts, Filters>): TableDataProviderInst<Model, Service, Sorts, Filters, ModelClass, ServiceClassType<Service>>;

package/table/api/descriptors/column.descriptor.d.ts

@@ -83,30 +83,151 @@ export declare class ColumnDescriptor<ColumnModel, TableModel, ColumnValue = Col
     get localizationExistsProperty(): string | undefined;
     /**
      * Converts column to given type with additional arguments
-     * @param type column type enum
-     * @param displayType column display type
-     * @param args any additional arguments for column (optional)
+     *
+     * @param type Column type enum.
+     * @param displayType Column display type
+     * @param args Any additional arguments that might be needed for specific target type.
      */
     asType(type: ColumnTypeEnum, displayType?: ColumnDisplayTypeEnum, ...args: any[]): this;
+    /**
+     * Set column display as number.
+     *
+     * @param opts Options for number display.
+     */
     asNumber(opts?: ColumnNumberOptsType): this;
+    /**
+     * Set column display as currency.
+     *
+     * @param opts Options for currency display.
+     */
     asCurrency(opts?: ColumnCurrencyOptsType<keyof TableModel>): this;
+    /**
+     * Set column display as currency.
+     *
+     * This function is UNSAFE!
+     *
+     * @param opts Options for currency display.
+     */
     asCurrencyUnsafe(opts?: ColumnCurrencyOptsType): this;
+    /**
+     * Set column display as date.
+     *
+     * @param displayFormat Date display format (in Angular date formatting).
+     */
     asDate(displayFormat?: string): this;
+    /**
+     * Set column display as boolean.
+     *
+     * @param yes Translation key for true value.
+     * @param no Translation key for false value.
+     * @param asIcon Use true/false texts as icon.
+     */
     asBoolean(yes?: string, no?: string, asIcon?: boolean): this;
+    /**
+     * Set column display as enum.
+     *
+     * @param enumDesc Enum descriptor for value display.
+     */
     asEnumUnsafe(enumDesc: EnumDescriptor<any>): this;
+    /**
+     * Set column display with custom component.
+     *
+     * @param customComponentType Component type to be used for display. Must implement {IColumnValueComponent}.
+     */
     asCustomComponent(customComponentType: Type<IColumnValueComponent<ColumnValue, TableModel, ColumnModel>>): this;
+    /**
+     * Sets columns display as HTML using Angular innerHTML.
+     */
     asHtml(): this;
+    /**
+     * Sets the class names for the column.
+     *
+     * @param className - The class name for the element column.
+     * @param headerClassName - The class name for the header element of the column.
+     * @param classNameMapFn - A function to return class name based on the current class name and row item value.
+     */
     withClassName(className?: string, headerClassName?: string, classNameMapFn?: (className?: string, item?: TableModel) => string): this;
+    /**
+     * Sets the width for the column.
+     *
+     * @param width - The desired width in percents (relative to table width).
+     * @param minWidth - The minimum width of column in pixels.
+     * @param maxWidth - The maximum width of column in pixels.
+     */
     withWidth(width?: number, minWidth?: number, maxWidth?: number): this;
-    withTitle(title: string): this;
+    /**
+     * Sets the title for the column. If title is undefined, then the title will be calculated based on table model (i18nBase) and column property.
+     *
+     * @param title - The title of the column.
+     */
+    withTitle(title?: string): this;
+    /**
+     * Enables button that copies column value to the clipboard.
+     *
+     * @param hasCopyToClipboard - Flag to enable/disable the feature.
+     * @param clipboardValueGetter - Optional getter function to adjust the value to be copied to clipboard.
+     */
     withCopyToClipboard(hasCopyToClipboard?: boolean, clipboardValueGetter?: GetterFn<ColumnValue, TableModel>): this;
+    /**
+     * Sets the template for displaying value.
+     *
+     * Use `{{}}` syntax for string interpolation within template.
+     * Use `item` key to access value of row item.
+     *
+     * Example interpolates row item's title within some text:
+     * ```
+     * This template shows {{item.title}} value in column.
+     * ```
+     *
+     * @param {string} template - The template to set.
+     *
+     * @usageNotes
+     * Display item's title property within some text:
+     *
+     * ```
+     * This template shows {{item.title}} value in column.
+     * ```
+     */
     withTemplate(template: string): this;
+    /**
+     * Sets the getter function for adjusting the column value for display.
+     *
+     * @param {GetterFn<ColumnValue, TableModel>} getter - The getter function to be used.
+     */
     withGetter(getter?: GetterFn<ColumnValue, TableModel>): this;
+    /**
+     * Show text in multiple lines (useful for displaying of long texts).
+     *
+     * @param isMultiline Enables/disabled the feature.
+     */
     withMultiline(isMultiline?: boolean): this;
+    /**
+     * Shows the whole display value as text (usefule when display values are expected to be to long and/or are overflown).
+     *
+     * @param valueAsTooltip Enables/disabled the feature.
+     */
     withValueAsTooltip(valueAsTooltip?: boolean): this;
+    /**
+     * Enables ordering of column.
+     *
+     * @param isReorderable Flag to enable/disable reordering.
+     */
     withReorderable(isReorderable?: boolean): this;
+    /**
+     * Enables toggling column visibility.
+     *
+     * @param isReorderable Flag to enable/disable visibility toggle.
+     */
     withToggleable(isToggleable?: boolean, isVisible?: boolean): this;
-    localized(existsProperty?: string): this;
+    /**
+     * Enables localization of column by displaying flag if the column value is localized (or just displaying default fallback text).
+     *
+     * @param existsProperty Property to mark
+     */
+    localized(existsProperty?: keyof TableModel): this;
+    /**
+     * Copies current descriptor to a new instance.
+     */
     copy(): ColumnDescriptor<ColumnModel, TableModel, ColumnValue>;
     protected copyFieldsTo(obj: ColumnDescriptor<ColumnModel, TableModel, ColumnValue>): void;
 }

package/table/api/descriptors/sort.descriptor.d.ts

@@ -10,8 +10,30 @@ export declare class SortDescriptor<TableModel> {
     get defaultIsEnabled(): boolean;
     get defaultIsAscending(): boolean | undefined;
     get defaultOrder(): number | undefined;
+    /**
+     * Shows sort on column for giver property.
+     *
+     * @param property Column property.
+     */
     withShowOnColumn(property: keyof TableModel): this;
+    /**
+     * Shows sort on column for giver property.
+     *
+     * This function is UNSAFE!
+     *
+     * @param property Column property.
+     */
     withShowOnColumnUnsafe(property: string): this;
+    /**
+     * Sets the default sort for this descriptor.
+     *
+     * @param {boolean} enabled - Enables/disables the feature. Default is true.
+     * @param {boolean} [ascending] - If the sort is ascending. Default is true.
+     * @param {number} [order] - Order index in case of multiple default sorts.
+     */
     withDefaultSort(enabled?: boolean, ascending?: boolean, order?: number): this;
+    /**
+     * Copies current descriptor to a new instance.
+     */
     copy(): SortDescriptor<TableModel>;
 }

package/table/api/descriptors/table-descriptor.factory.d.ts

@@ -23,11 +23,15 @@ export declare class TableDescriptor extends TableDescriptorInst<any> {
      */
     static fromClassWithCustomAttrsDef<TableModel>(type: ClassType<TableModel>, attributes: TableClassAttributeDef[], idProperty?: keyof TableModel, titleProperty?: keyof TableModel): TableDescriptorInst<TableModel>;
 }
-export type TableDescriptorCreateOptsType<TableModel> = ModelDescriptorCreateOpts<TableModel>;
+export type TableDescriptorSortsFiltersCreateOptsType<TableModel, Sorts = keyof TableModel, Filters = keyof TableModel> = {
+    filtersType?: TypeDescriptor<Filters>;
+    sortsType?: TypeDescriptor<Sorts>;
+};
+export type TableDescriptorCreateOptsType<TableModel, Sorts = keyof TableModel, Filters = keyof TableModel> = TableDescriptorSortsFiltersCreateOptsType<TableModel, Sorts, Filters> & ModelDescriptorCreateOpts<TableModel>;
 export declare function tableDescriptor<TableModel, Sorts = keyof TableModel, Filters = keyof TableModel>(): TableDescriptorInst<TableModel, Sorts, Filters>;
-export declare function tableDescriptor<TableModel, Sorts = keyof TableModel, Filters = keyof TableModel>(opts: TableDescriptorCreateOptsType<TableModel>): TableDescriptorInst<TableModel, Sorts, Filters>;
-export declare function tableDescriptor<TableModel, Sorts = keyof TableModel, Filters = keyof TableModel>(model: ModelDescriptor<TableModel>): TableDescriptorInst<TableModel, Sorts, Filters>;
-export declare function tableDescriptor<TableModel, Sorts = keyof TableModel, Filters = keyof TableModel>(type: TypeDescriptor<TableModel>, opts?: TableDescriptorCreateOptsType<TableModel>): TableDescriptorInst<TableModel, Sorts, Filters>;
+export declare function tableDescriptor<TableModel, Sorts = keyof TableModel, Filters = keyof TableModel>(opts: TableDescriptorCreateOptsType<TableModel, Sorts, Filters>): TableDescriptorInst<TableModel, Sorts, Filters>;
+export declare function tableDescriptor<TableModel, Sorts = keyof TableModel, Filters = keyof TableModel>(model: ModelDescriptor<TableModel>, opts?: TableDescriptorSortsFiltersCreateOptsType<TableModel, Sorts, Filters>): TableDescriptorInst<TableModel, Sorts, Filters>;
+export declare function tableDescriptor<TableModel, Sorts = keyof TableModel, Filters = keyof TableModel>(type: TypeDescriptor<TableModel>, opts?: TableDescriptorCreateOptsType<TableModel, Sorts, Filters>): TableDescriptorInst<TableModel, Sorts, Filters>;
 export declare function tableDescriptorFromClass<TableModel, Sorts = keyof TableModel, Filters = keyof TableModel>(type: ClassType<TableModel>, opts?: TableDescriptorCreateOptsType<TableModel>): TableDescriptorInst<TableModel, Sorts, Filters>;
 /**
  * generates descriptor based on type attribute definition