@mediusinc/mng-commons 6.2.0-rc.0 → 7.0.0-rc.0

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

@@ -1,269 +0,0 @@
-import { Type } from '@angular/core';
-import { GetterFn } from '@mediusinc/mng-commons/core';
-import { EnumDescriptor } from '@mediusinc/mng-commons/model';
-import { IColumnValueComponent } from '../models/column-value.model';
-import { ColumnDisplayTypeEnum, ColumnTypeEnum } from '../models/column.model';
-export type ColumnComponentOpts = {
-    inputs?: Record<string, any>;
-};
-export type ColumnCurrencyOptsType<Property = string> = {
-    currencyProperty?: Property;
-    currency?: string;
-    currencyDisplay?: 'symbol' | 'code' | 'name';
-} & ColumnNumberFractionOptsType & ColumnLocaleOptsType;
-export type ColumnNumberOptsType = ColumnNumberFractionOptsType & ColumnLocaleOptsType;
-export type ColumnNumberFractionOptsType = {
-    minIntegerDigits?: number;
-    minFractionDigits?: number;
-    maxFractionDigits?: number;
-};
-export type ColumnLocaleOptsType = {
-    locale?: string;
-};
-export declare class ColumnDescriptor<ColumnModel, TableModel, ColumnValue = ColumnModel> {
-    protected readonly _property: string;
-    private _columnType;
-    private _columnDisplayType;
-    protected _title?: string;
-    private _titleUseModelBase?;
-    private _displayFormat?;
-    private _locale?;
-    private _template?;
-    private _getter?;
-    private _isMultiline;
-    private _hasValueAsTooltip;
-    private _isReorderable;
-    private _isToggleable;
-    private _isVisible;
-    private _headerClassName;
-    private _className;
-    private _classNameMapFn?;
-    private _width;
-    private _minWidth;
-    private _maxWidth;
-    private _enum?;
-    private _booleanAsIcon;
-    private _booleanYes?;
-    private _booleanNo?;
-    private _currencyCode?;
-    private _currencyProperty?;
-    private _currencyDisplay?;
-    private _customComponentType?;
-    private _customComponentInputs?;
-    private _hasCopyToClipboard;
-    private _clipboardValueGetter?;
-    private _isLocalized;
-    private _localizationExistsProperty?;
-    constructor(property: string);
-    get columnType(): ColumnTypeEnum;
-    get columnDisplayType(): ColumnDisplayTypeEnum;
-    get title(): string | undefined;
-    get titleUseModelBase(): boolean | undefined;
-    get displayFormat(): string | undefined;
-    get property(): string;
-    get headerClassName(): string;
-    get className(): string;
-    get classNameMapFn(): ((className?: string, item?: TableModel) => string) | undefined;
-    get width(): number | null;
-    get minWidth(): number | null;
-    get maxWidth(): number | null;
-    get enum(): EnumDescriptor<any> | undefined;
-    get booleanAsIcon(): boolean;
-    get booleanYes(): string | undefined;
-    get booleanNo(): string | undefined;
-    get customComponentType(): Type<IColumnValueComponent<ColumnValue, TableModel, ColumnModel>> | undefined;
-    get customComponentInputs(): Record<string, any> | undefined;
-    get locale(): string | undefined;
-    get currencyCode(): string | undefined;
-    get currencyDisplay(): "symbol" | "code" | "name" | undefined;
-    get currencyProperty(): string | undefined;
-    get hasCopyToClipboard(): boolean;
-    get clipboardValueGetter(): GetterFn<ColumnValue, TableModel> | undefined;
-    get template(): string | undefined;
-    get getter(): GetterFn<ColumnValue, TableModel> | undefined;
-    get isMultiline(): boolean;
-    get hasValueAsTooltip(): boolean;
-    get isReorderable(): boolean;
-    get isToggleable(): boolean;
-    get isVisible(): boolean;
-    get isLocalized(): boolean;
-    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 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}.
-     * @param opts Options for the custom component, including inputs to pass to the component.
-     */
-    asCustomComponent(customComponentType: Type<IColumnValueComponent<ColumnValue, TableModel, ColumnModel>>, opts?: ColumnComponentOpts): 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;
-    /**
-     * 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.
-     * @param useModelBase - Whether to append title to model's i18n path.
-     */
-    withTitle(title?: string, useModelBase?: boolean): 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;
-    /**
-     * 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;
-}
-export declare class ColumnDynamicDescriptor extends ColumnDescriptor<any, any> {
-    protected _title: string | undefined;
-    private _visibility;
-    constructor(property: string);
-    get visibility(): boolean;
-    /**
-     * sets column's title and returns this column
-     * @param title title to be set
-     * @param override should column title if all ready set?
-     */
-    withTitle(title: string, override?: boolean): this;
-    /**
-     * defines automatic type and returns this column
-     * @param value
-     */
-    withAutomaticType(value: string): this;
-    /**
-     * sets visibility state for column and returns this column
-     * @param visibility
-     */
-    withVisibility(visibility: boolean): this;
-    /**
-     * creates deep copy of column dynamic descriptor
-     */
-    copy(): ColumnDynamicDescriptor;
-    toColumnDescriptor(): ColumnDescriptor<any, any>;
-}

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

@@ -1,39 +0,0 @@
-export declare class SortDescriptor<TableModel> {
-    protected readonly _property: string;
-    protected _showOnColumn: string;
-    protected _defaultIsEnabled: boolean;
-    protected _defaultIsAscending: boolean;
-    protected _defaultOrder?: number;
-    constructor(property: string);
-    get property(): string;
-    get showOnColumn(): string;
-    get defaultIsEnabled(): boolean;
-    get defaultIsAscending(): boolean;
-    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

@@ -1,12 +0,0 @@
-import { ModelDescriptor, ModelDescriptorCreateOpts, TypeDescriptor } from '@mediusinc/mng-commons/model';
-import { TableDescriptorInst, TableDynamicDescriptorInst } from './table.descriptor';
-export type TableDescriptorSortsFiltersCreateOptsType<TableModel, Sorts = keyof TableModel, Filters = keyof TableModel> = {
-    filtersType?: TypeDescriptor<Filters> | ModelDescriptor<Filters>;
-    sortsType?: TypeDescriptor<Sorts> | ModelDescriptor<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, 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>(opts?: TableDescriptorCreateOptsType<TableModel, Sorts, Filters>): TableDescriptorInst<TableModel, Sorts, Filters>;
-export declare function tableDynamicDescriptor(modelOrOpts?: ModelDescriptor<any> | TableDescriptorCreateOptsType<any>): TableDynamicDescriptorInst;