@mediusinc/mng-commons 0.17.5 → 0.18.0-rc.1

package/lib/descriptors/column.descriptor.d.ts

@@ -1,122 +1,123 @@
-import { Type } from '@angular/core';
-import { IColumnValueComponent } from '../models';
-import { ClassType, EnumConstantType, EnumType } from '../types';
-import { FilterDescriptor, FilterLookupDescriptor, FilterLookupEnumDescriptor } from './filter.descriptor';
-import { TableDescriptor, TableDynamicDescriptor } from './table.descriptor';
-import { ColumnTypeEnum } from './types';
-export declare class ColumnDescriptor<T, TT> {
-    protected readonly _table: TableDescriptor<TT>;
-    protected readonly _property: string;
-    private _columnType;
-    protected _title?: string;
-    private _jsonPath?;
-    private _isSortEnabled;
-    private _filterDescriptor?;
-    private _displayFormat?;
-    private _locale?;
-    private _template?;
-    private _getter?;
-    private _headerClassName;
-    private _className;
-    private _width;
-    private _minWidth;
-    private _maxWidth;
-    private _enumType?;
-    private _enumTitlePath?;
-    private _enumNameAsValue;
-    private _booleanAsIcon;
-    private _booleanYes?;
-    private _booleanNo?;
-    private _objectModelType?;
-    private _objectTitleProperty?;
-    private _currencyCode?;
-    private _currencyFromProperty?;
-    private _currencyDisplay?;
-    private _customComponentType?;
-    private _hasCopyToClipboard;
-    constructor(table: TableDescriptor<TT>, property: string);
-    get columnType(): ColumnTypeEnum;
-    get title(): string | undefined;
-    get jsonPath(): string | undefined;
-    get isSortEnabled(): boolean;
-    get filterDescriptor(): FilterDescriptor<T> | undefined;
-    get displayFormat(): string | undefined;
-    get table(): TableDescriptor<TT>;
-    get property(): string;
-    get headerClassName(): string;
-    get className(): string;
-    get width(): number | null;
-    get minWidth(): number | null;
-    get maxWidth(): number | null;
-    get enumType(): EnumType | undefined;
-    get enumTitlePath(): string | null | undefined;
-    get enumNameAsValue(): boolean;
-    get booleanAsIcon(): boolean;
-    get booleanYes(): string | undefined;
-    get booleanNo(): string | undefined;
-    get objectModelType(): ClassType<unknown> | undefined;
-    get objectTitleProperty(): string | undefined;
-    get customComponentType(): Type<IColumnValueComponent<TT>> | undefined;
-    get locale(): string | undefined;
-    get currencyCode(): string | undefined;
-    get currencyDisplay(): "symbol" | "code" | "name" | undefined;
-    get currencyFromProperty(): string | undefined;
-    get hasCopyToClipboard(): boolean;
-    get template(): string | undefined;
-    get getter(): ((item: any) => any) | undefined;
-    /**
-     * converts column to given type with additional arguments
-     * @param type column type enum
-     * @param args any additional arguments for column (optional)
-     */
-    asType(type: ColumnTypeEnum, ...args: any[]): this;
-    asNumber(displayFormat?: string, locale?: string): this;
-    asCurrency(currencyCode?: string, currencyFromProperty?: string, currencyDisplay?: 'symbol' | 'code' | 'name', displayFormat?: string, locale?: string): this;
-    asDate(displayFormat?: string): this;
-    asBoolean(yes?: string, no?: string, asIcon?: boolean): this;
-    asEnum(enumType: EnumType, nameAsValue?: boolean, titlePath?: string | null): this;
-    asCustomComponent(customComponentType: Type<IColumnValueComponent<TT>>): this;
-    withClassName(className?: string, headerClassName?: string): this;
-    withWidth(width?: number, minWidth?: number, maxWidth?: number): this;
-    withObjectProperty<MT>(modelType: ClassType<MT>, titleProperty?: string): this;
-    withTitle(title: string): this;
-    withJsonPath(path: string): this;
-    withFilter(forceSimple?: boolean): FilterDescriptor<T>;
-    withFilterLookup(): FilterLookupDescriptor<unknown>;
-    withFilterLookupEnum(options?: Array<EnumConstantType>): FilterLookupEnumDescriptor;
-    withSort(isEnabled?: boolean): this;
-    withDefaultSort(asc?: boolean): this;
-    withCopyToClipboard(hasCopyToCliboard?: boolean): this;
-    withTemplate(template: string): this;
-    withGetter(getter?: (item: any) => any): this;
-    copy(): ColumnDescriptor<T, TT>;
-    protected copyFieldsTo(obj: ColumnDescriptor<T, TT>): void;
-}
-export declare class ColumnDynamicDescriptor extends ColumnDescriptor<any, any> {
-    protected _table: TableDynamicDescriptor;
-    protected _title: string | undefined;
-    private _visibility;
-    constructor(table: TableDynamicDescriptor, 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(tableDescriptor: TableDescriptor<any>): ColumnDescriptor<any, any>;
-}
+import { Type } from '@angular/core';
+import { IColumnValueComponent } from '../models';
+import { ClassType, EnumConstantType, EnumType } from '../types';
+import { FilterDescriptor, FilterLookupDescriptor, FilterLookupEnumDescriptor } from './filter.descriptor';
+import { TableDescriptor, TableDynamicDescriptor } from './table.descriptor';
+import { ColumnTypeEnum } from './types';
+export declare class ColumnDescriptor<T, TT> {
+    protected readonly _table: TableDescriptor<TT>;
+    protected readonly _property: string;
+    private _columnType;
+    protected _title?: string;
+    private _jsonPath?;
+    private _isSortEnabled;
+    private _filterDescriptor?;
+    private _displayFormat?;
+    private _locale?;
+    private _template?;
+    private _getter?;
+    private _headerClassName;
+    private _className;
+    private _width;
+    private _minWidth;
+    private _maxWidth;
+    private _enumType?;
+    private _enumTitlePath?;
+    private _enumNameAsValue;
+    private _booleanAsIcon;
+    private _booleanYes?;
+    private _booleanNo?;
+    private _objectModelType?;
+    private _objectTitleProperty?;
+    private _currencyCode?;
+    private _currencyFromProperty?;
+    private _currencyDisplay?;
+    private _customComponentType?;
+    private _hasCopyToClipboard;
+    constructor(table: TableDescriptor<TT>, property: string);
+    get columnType(): ColumnTypeEnum;
+    get title(): string | undefined;
+    get jsonPath(): string | undefined;
+    get isSortEnabled(): boolean;
+    get filterDescriptor(): FilterDescriptor<T> | undefined;
+    get displayFormat(): string | undefined;
+    get table(): TableDescriptor<TT>;
+    get property(): string;
+    get headerClassName(): string;
+    get className(): string;
+    get width(): number | null;
+    get minWidth(): number | null;
+    get maxWidth(): number | null;
+    get enumType(): EnumType | undefined;
+    get enumTitlePath(): string | null | undefined;
+    get enumNameAsValue(): boolean;
+    get booleanAsIcon(): boolean;
+    get booleanYes(): string | undefined;
+    get booleanNo(): string | undefined;
+    get objectModelType(): ClassType<unknown> | undefined;
+    get objectTitleProperty(): string | undefined;
+    get customComponentType(): Type<IColumnValueComponent<TT>> | undefined;
+    get locale(): string | undefined;
+    get currencyCode(): string | undefined;
+    get currencyDisplay(): "symbol" | "code" | "name" | undefined;
+    get currencyFromProperty(): string | undefined;
+    get hasCopyToClipboard(): boolean;
+    get template(): string | undefined;
+    get getter(): ((item: TT, value?: T | null | undefined) => unknown) | undefined;
+    /**
+     * converts column to given type with additional arguments
+     * @param type column type enum
+     * @param args any additional arguments for column (optional)
+     */
+    asType(type: ColumnTypeEnum, ...args: any[]): this;
+    asNumber(displayFormat?: string, locale?: string): this;
+    asCurrency(currencyCode?: string, currencyFromProperty?: string, currencyDisplay?: 'symbol' | 'code' | 'name', displayFormat?: string, locale?: string): this;
+    asDate(displayFormat?: string): this;
+    asBoolean(yes?: string, no?: string, asIcon?: boolean): this;
+    asEnum(enumType: EnumType, nameAsValue?: boolean, titlePath?: string | null): this;
+    asCustomComponent(customComponentType: Type<IColumnValueComponent<TT>>): this;
+    asHtml(): this;
+    withClassName(className?: string, headerClassName?: string): this;
+    withWidth(width?: number, minWidth?: number, maxWidth?: number): this;
+    withObjectProperty<MT>(modelType: ClassType<MT>, titleProperty?: string): this;
+    withTitle(title: string): this;
+    withJsonPath(path: string): this;
+    withFilter(forceSimple?: boolean): FilterDescriptor<T>;
+    withFilterLookup(): FilterLookupDescriptor<unknown>;
+    withFilterLookupEnum(options?: Array<EnumConstantType>): FilterLookupEnumDescriptor;
+    withSort(isEnabled?: boolean): this;
+    withDefaultSort(asc?: boolean): this;
+    withCopyToClipboard(hasCopyToCliboard?: boolean): this;
+    withTemplate(template: string): this;
+    withGetter(getter?: (item: TT, value?: T | null) => unknown): this;
+    copy(): ColumnDescriptor<T, TT>;
+    protected copyFieldsTo(obj: ColumnDescriptor<T, TT>): void;
+}
+export declare class ColumnDynamicDescriptor extends ColumnDescriptor<any, any> {
+    protected _table: TableDynamicDescriptor;
+    protected _title: string | undefined;
+    private _visibility;
+    constructor(table: TableDynamicDescriptor, 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(tableDescriptor: TableDescriptor<any>): ColumnDescriptor<any, any>;
+}

package/lib/descriptors/editor.descriptor.d.ts

@@ -1,94 +1,95 @@
-import { ILookupDataProvider } from '../data-providers';
-import { TableviewAttributeDef } from '../models/tableview-attr.model';
-import { ClassType, EnumConstantType, EnumType, MngFieldValidationMessage, MngFieldValidator } from '../types';
-import { AFieldDescriptor, FieldGroupDescriptor, FieldInputDescriptor, FieldLookupDescriptor, FieldLookupEnumDescriptor, FieldManyEditorDescriptor, FieldManyToManyEditorDescriptor, FieldTabGroupDescriptor, ModelDescriptor, TableDescriptor, TableviewDescriptor } from './';
-import { FieldInputTypeEnum, TableviewEditorTypeEnum } from './types';
-export declare class EditorDescriptor<T> {
-    static readonly defaultGroupName = "_default";
-    protected readonly _model: ModelDescriptor<T>;
-    protected readonly _modelType: ClassType<T>;
-    protected readonly _tableviewEditorType: TableviewEditorTypeEnum;
-    protected readonly _tabs: Array<FieldTabGroupDescriptor<T>>;
-    protected readonly _groups: Array<FieldGroupDescriptor<T>>;
-    protected _fields: Array<AFieldDescriptor<any, T>>;
-    protected _currentTabGroup?: FieldTabGroupDescriptor<T>;
-    protected _currentGroup?: FieldGroupDescriptor<T>;
-    protected _disabled: boolean;
-    constructor(modelType: ClassType<T>, idProperty?: string, titleProperty?: string, tableviewEditorType?: TableviewEditorTypeEnum, i18nBaseKey?: string | ClassType<unknown>);
-    /**
-     * auto generated editor descriptor based on openapi definition
-     * generates all fields from definition
-     * @param modelType class type
-     * @param idProperty
-     * @param titleProperty
-     * @param tableEditorType
-     */
-    static from<T>(modelType: ClassType<T>, idProperty?: string, titleProperty?: string, tableEditorType?: TableviewEditorTypeEnum): EditorDescriptor<T>;
-    /**
-     * auto generated editor descriptor based on openapi definition
-     * generates only selected fields
-     * @param modelType class type
-     * @param attributes list of selected properties to generate fields based on
-     * @param idProperty
-     * @param titleProperty
-     * @param tableEditorType
-     */
-    static fromModelWithAttributes<T>(modelType: ClassType<T>, attributes: TableviewAttributeDef[], idProperty?: string, titleProperty?: string, tableEditorType?: TableviewEditorTypeEnum): EditorDescriptor<T>;
-    get model(): ModelDescriptor<T>;
-    get tabs(): FieldTabGroupDescriptor<T>[];
-    get fields(): AFieldDescriptor<any, T>[];
-    get disabled(): boolean;
-    createTabGroup(name: string, title?: string): FieldTabGroupDescriptor<T>;
-    createFieldGroup(name: string, title?: string | null): FieldGroupDescriptor<T>;
-    addFieldDescriptor<FT>(field: AFieldDescriptor<FT, T>): this;
-    addField(property: string): FieldInputDescriptor<T>;
-    /**
-     * removes filed if exists in descriptor
-     * @param property field name
-     */
-    removeField(property: string): void;
-    getField(property: string): AFieldDescriptor<any, T> | null;
-    addFieldLookup<FT>(property: string, modelType: ClassType<FT>): FieldLookupDescriptor<FT, T>;
-    addFieldLookupEnum(property: string, enumType: EnumType, options?: Array<EnumConstantType>, nameAsValue?: boolean, optionsTitlePath?: string | null): FieldLookupEnumDescriptor<T>;
-    addFieldManyEditor<FT>(property: string, tableviewDescriptor: TableviewDescriptor<FT>): FieldManyEditorDescriptor<FT, T>;
-    addFieldManyToManyEditor<FT>(property: string, mainTableDescriptor: TableDescriptor<FT>, lookupTableDescriptor: TableDescriptor<FT>): FieldManyToManyEditorDescriptor<FT, T>;
-    withDisabled(disabled?: boolean): this;
-    addValidation(name: string, validator?: MngFieldValidator, message?: MngFieldValidationMessage): void;
-    copy(): EditorDescriptor<T>;
-    createFieldGroupDescriptor(fieldGroup: FieldGroupDescriptor<T>): this;
-    protected createTabGroupDescriptor(tabGroup: FieldTabGroupDescriptor<T>): this;
-    private createDefaultGroup;
-    private createDefaultTabGroup;
-    /**
-     * modifies selected field
-     * do not use it for enums! (use withFieldModifiedEnum instead)
-     * @param property field name
-     * @param fieldType new field type for selected field
-     * @param args additional parameters for field
-     */
-    withFieldModifiedType(property: string, fieldType: FieldInputTypeEnum, ...args: any[]): this;
-    /**
-     * modifies selected field with enum type
-     * @param property field property name
-     * @param enumType type of enum for new field
-     * @param optionsTitlePath
-     * @param values
-     * @param nameAsValue
-     */
-    withFieldModifiedEnum(property: string, enumType?: EnumType, optionsTitlePath?: string | null, values?: Array<EnumConstantType>, nameAsValue?: boolean): this;
-    /**
-     * adds lookup to given field
-     * @param property field property name
-     * @param modelType model type of field
-     * @param lookupProvider provider to be added to field
-     * @param titleProperty
-     */
-    withFieldModifiedLookup<MT>(property: string, modelType: ClassType<MT>, lookupProvider: ILookupDataProvider<any, any>, titleProperty?: string): this;
-    /**
-     * generates field based on attribute definition, used for auto model
-     * @param attribute definition
-     * @param field optional, if defined will be replaced, otherwise new will be generated
-     * @param args additional arguments
-     */
-    private upsertFieldFromAttributeDef;
-}
+import { ILookupDataProvider } from '../data-providers';
+import { TableviewAttributeDef } from '../models/tableview-attr.model';
+import { ClassType, EnumConstantType, EnumType, MngFieldValidationMessage, MngFieldValidator } from '../types';
+import { AFieldDescriptor, FieldActionDescriptor, FieldGroupDescriptor, FieldInputDescriptor, FieldLookupDescriptor, FieldLookupEnumDescriptor, FieldManyEditorDescriptor, FieldManyToManyEditorDescriptor, FieldTabGroupDescriptor, ModelDescriptor, TableDescriptor, TableviewDescriptor } from './';
+import { FieldInputTypeEnum, TableviewEditorTypeEnum } from './types';
+export declare class EditorDescriptor<T> {
+    static readonly defaultGroupName = "_default";
+    protected readonly _model: ModelDescriptor<T>;
+    protected readonly _modelType: ClassType<T>;
+    protected readonly _tableviewEditorType: TableviewEditorTypeEnum;
+    protected readonly _tabs: Array<FieldTabGroupDescriptor<T>>;
+    protected readonly _groups: Array<FieldGroupDescriptor<T>>;
+    protected _fields: Array<AFieldDescriptor<any, T>>;
+    protected _currentTabGroup?: FieldTabGroupDescriptor<T>;
+    protected _currentGroup?: FieldGroupDescriptor<T>;
+    protected _disabled: boolean;
+    constructor(modelType: ClassType<T>, idProperty?: string, titleProperty?: string, tableviewEditorType?: TableviewEditorTypeEnum, i18nBaseKey?: string | ClassType<unknown>);
+    /**
+     * auto generated editor descriptor based on openapi definition
+     * generates all fields from definition
+     * @param modelType class type
+     * @param idProperty
+     * @param titleProperty
+     * @param tableEditorType
+     */
+    static from<T>(modelType: ClassType<T>, idProperty?: string, titleProperty?: string, tableEditorType?: TableviewEditorTypeEnum): EditorDescriptor<T>;
+    /**
+     * auto generated editor descriptor based on openapi definition
+     * generates only selected fields
+     * @param modelType class type
+     * @param attributes list of selected properties to generate fields based on
+     * @param idProperty
+     * @param titleProperty
+     * @param tableEditorType
+     */
+    static fromModelWithAttributes<T>(modelType: ClassType<T>, attributes: TableviewAttributeDef[], idProperty?: string, titleProperty?: string, tableEditorType?: TableviewEditorTypeEnum): EditorDescriptor<T>;
+    get model(): ModelDescriptor<T>;
+    get tabs(): FieldTabGroupDescriptor<T>[];
+    get fields(): AFieldDescriptor<any, T>[];
+    get disabled(): boolean;
+    createTabGroup(name: string, title?: string): FieldTabGroupDescriptor<T>;
+    createFieldGroup(name: string, title?: string | null): FieldGroupDescriptor<T>;
+    addFieldDescriptor<FT>(field: AFieldDescriptor<FT, T>): this;
+    addField(property: string): FieldInputDescriptor<T>;
+    /**
+     * removes filed if exists in descriptor
+     * @param property field name
+     */
+    removeField(property: string): void;
+    getField(property: string): AFieldDescriptor<any, T> | null;
+    addFieldAction(actionName: string): FieldActionDescriptor<T>;
+    addFieldLookup<FT>(property: string, modelType: ClassType<FT>): FieldLookupDescriptor<FT, T>;
+    addFieldLookupEnum(property: string, enumType: EnumType, options?: Array<EnumConstantType>, nameAsValue?: boolean, optionsTitlePath?: string | null): FieldLookupEnumDescriptor<T>;
+    addFieldManyEditor<FT>(property: string, tableviewDescriptor: TableviewDescriptor<FT>): FieldManyEditorDescriptor<FT, T>;
+    addFieldManyToManyEditor<FT>(property: string, mainTableDescriptor: TableDescriptor<FT>, lookupTableDescriptor: TableDescriptor<FT>): FieldManyToManyEditorDescriptor<FT, T>;
+    withDisabled(disabled?: boolean): this;
+    addValidation(name: string, validator?: MngFieldValidator, message?: MngFieldValidationMessage): void;
+    copy(): EditorDescriptor<T>;
+    createFieldGroupDescriptor(fieldGroup: FieldGroupDescriptor<T>): this;
+    protected createTabGroupDescriptor(tabGroup: FieldTabGroupDescriptor<T>): this;
+    private createDefaultGroup;
+    private createDefaultTabGroup;
+    /**
+     * modifies selected field
+     * do not use it for enums! (use withFieldModifiedEnum instead)
+     * @param property field name
+     * @param fieldType new field type for selected field
+     * @param args additional parameters for field
+     */
+    withFieldModifiedType(property: string, fieldType: FieldInputTypeEnum, ...args: any[]): this;
+    /**
+     * modifies selected field with enum type
+     * @param property field property name
+     * @param enumType type of enum for new field
+     * @param optionsTitlePath
+     * @param values
+     * @param nameAsValue
+     */
+    withFieldModifiedEnum(property: string, enumType?: EnumType, optionsTitlePath?: string | null, values?: Array<EnumConstantType>, nameAsValue?: boolean): this;
+    /**
+     * adds lookup to given field
+     * @param property field property name
+     * @param modelType model type of field
+     * @param lookupProvider provider to be added to field
+     * @param titleProperty
+     */
+    withFieldModifiedLookup<MT>(property: string, modelType: ClassType<MT>, lookupProvider: ILookupDataProvider<any, any>, titleProperty?: string): this;
+    /**
+     * generates field based on attribute definition, used for auto model
+     * @param attribute definition
+     * @param field optional, if defined will be replaced, otherwise new will be generated
+     * @param args additional arguments
+     */
+    private upsertFieldFromAttributeDef;
+}

package/lib/descriptors/field-validation.descriptor.d.ts

@@ -1,18 +1,18 @@
-import { FormlyFieldConfig } from '@ngx-formly/core';
-import { Observable } from 'rxjs';
-import { MngFieldAsyncValidator, MngFieldValidationMessage, MngFieldValidator } from '../types';
-export declare class FieldValidationDescriptor {
-    private readonly _name;
-    private readonly _validator?;
-    private readonly _message?;
-    private readonly _options?;
-    constructor(name: string, validator?: MngFieldValidator | MngFieldAsyncValidator, message?: string | ((error: any, field: FormlyFieldConfig) => string | Observable<string>), options?: {
-        errorPath: string;
-    });
-    get name(): string;
-    get validator(): MngFieldValidator | MngFieldAsyncValidator | undefined;
-    get message(): MngFieldValidationMessage | undefined;
-    get options(): {
-        errorPath: string;
-    } | undefined;
-}
+import { FormlyFieldConfig } from '@ngx-formly/core';
+import { Observable } from 'rxjs';
+import { MngFieldAsyncValidator, MngFieldValidationMessage, MngFieldValidator } from '../types';
+export declare class FieldValidationDescriptor {
+    private readonly _name;
+    private readonly _validator?;
+    private readonly _message?;
+    private readonly _options?;
+    constructor(name: string, validator?: MngFieldValidator | MngFieldAsyncValidator, message?: string | ((error: any, field: FormlyFieldConfig) => string | Observable<string>), options?: {
+        errorPath: string;
+    });
+    get name(): string;
+    get validator(): MngFieldValidator | MngFieldAsyncValidator | undefined;
+    get message(): MngFieldValidationMessage | undefined;
+    get options(): {
+        errorPath: string;
+    } | undefined;
+}