@mediusinc/mng-commons 0.12.2 → 0.12.3-rc.1

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

@@ -1,42 +1,141 @@
-import { Type } from '@angular/core';
-import { FieldValidatorFn } from '@ngx-formly/core/lib/models/config';
-import { IColumnValueComponent } from '../models';
-import { ClassType, EnumConstantType, EnumType } from '../types';
-import { AFieldDescriptor, ColumnDescriptor, EditorDescriptor, FieldInputDescriptor, FieldLookupDescriptor, FieldLookupEnumDescriptor, FieldManyEditorDescriptor, FieldManyToManyEditorDescriptor, ModelDescriptor, TableDescriptor } from './';
-export declare class TableviewDescriptor<T> {
-    private readonly _model;
-    constructor(modelType: ClassType<T>, idProperty?: string, titleProperty?: string);
-    private _table;
-    get table(): TableDescriptor<T>;
-    private _viewEditor;
-    get viewEditor(): EditorDescriptor<T>;
-    private _addEditor;
-    get addEditor(): EditorDescriptor<T>;
-    private _editEditor;
-    get editEditor(): EditorDescriptor<T>;
-    private _tableTitle;
-    get tableTitle(): string;
-    get model(): ModelDescriptor<T>;
-    withTableDescriptor(descriptor: TableDescriptor<T>): this;
-    withViewDescriptor(descriptor: EditorDescriptor<T>): this;
-    withAddDescriptor(descriptor: EditorDescriptor<T>): this;
-    withEditDescriptor(descriptor: EditorDescriptor<T>): this;
-    withTableTitle(title: string): this;
-    withValidator(name: string, expression: FieldValidatorFn): this;
-    addColumnDescriptor<CT>(column: ColumnDescriptor<CT, T>): TableDescriptor<T>;
-    addColumn(property: string): ColumnDescriptor<string, T>;
-    addColumnNumber(property: string, displayFormat?: string): ColumnDescriptor<number, T>;
-    addColumnDate(property: string, displayFormat?: string): ColumnDescriptor<Date, T>;
-    addColumnBoolean(property: string, yes?: string, no?: string, asIcon?: boolean): ColumnDescriptor<boolean, T>;
-    addColumnEnum(property: string, enumType: EnumType, nameAsValue?: boolean, titlePath?: string | null): ColumnDescriptor<EnumType, T>;
-    addColumnCustomComponent(property: string, customComponentType: Type<IColumnValueComponent<T>>): ColumnDescriptor<any, T>;
-    createTabGroup(name: string, title?: string): this;
-    createFieldGroup(name: string, title?: string): this;
-    addFieldDescriptor<FT>(field: AFieldDescriptor<FT, T>): this;
-    addField(property: string): FieldInputDescriptor<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>;
-    copy(): TableviewDescriptor<T>;
-}
+import { Type } from '@angular/core';
+import { FieldValidatorFn } from '@ngx-formly/core/lib/models/config';
+import { ILookupDataProvider } from '../data-providers';
+import { IColumnValueComponent } from '../models';
+import { ClassType, EnumConstantType, EnumType } from '../types';
+import { AFieldDescriptor, ColumnDescriptor, EditorAutoDescriptor, EditorDescriptor, FieldInputDescriptor, FieldLookupDescriptor, FieldLookupEnumDescriptor, FieldManyEditorDescriptor, FieldManyToManyEditorDescriptor, ModelDescriptor, TableAutoDescriptor, TableDescriptor, TableDynamicDescriptor } from './index';
+import { ColumnTypeEnum, FieldInputTypeEnum, TableviewTypeEnum } from './types';
+export declare class TableviewDescriptor<T> {
+    private readonly _model;
+    protected _table: TableDescriptor<T>;
+    protected _viewEditor: EditorDescriptor<T>;
+    protected _addEditor: EditorDescriptor<T>;
+    protected _editEditor: EditorDescriptor<T>;
+    protected _tableTitle?: string;
+    constructor(modelType: ClassType<T>, idProperty?: string, titleProperty?: string);
+    /**
+     * creates descriptor from modelType
+     * @param modelType
+     * @param attributes
+     * @param idProperty
+     * @param titleProperty
+     */
+    static autoTableview<T>(modelType: ClassType<T>, idProperty?: string, titleProperty?: string): TableviewAutoDescriptor<T>;
+    /**
+     * creates dynamic descriptor
+     * @param table
+     * @param idProperty
+     * @param titleProperty
+     */
+    static dynamicTableview(table?: TableDynamicDescriptor, idProperty?: string, titleProperty?: string): TableviewDynamicDescriptor;
+    get table(): TableDescriptor<T>;
+    get viewEditor(): EditorDescriptor<T>;
+    get addEditor(): EditorDescriptor<T>;
+    get editEditor(): EditorDescriptor<T>;
+    get tableTitle(): string | undefined;
+    get model(): ModelDescriptor<T>;
+    withTableDescriptor(descriptor: TableDescriptor<T>): this;
+    withViewDescriptor(descriptor: EditorDescriptor<T>): this;
+    withAddDescriptor(descriptor: EditorDescriptor<T>): this;
+    withEditDescriptor(descriptor: EditorDescriptor<T>): this;
+    withTableTitle(title: string): this;
+    withValidator(name: string, expression: FieldValidatorFn): this;
+    addColumnDescriptor<CT>(column: ColumnDescriptor<CT, T>): TableDescriptor<T>;
+    addColumn(property: string): ColumnDescriptor<string, T>;
+    getColumn(property: string): ColumnDescriptor<string, T> | undefined;
+    removeColumn(property: string): void;
+    replaceColumn(property: string): ColumnDescriptor<string, T> | undefined;
+    getField(property: string, editorType: TableviewTypeEnum): AFieldDescriptor<any, T> | null;
+    removeField(property: string): void;
+    addColumnNumber(property: string, displayFormat?: string): ColumnDescriptor<number, T>;
+    addColumnDate(property: string, displayFormat?: string): ColumnDescriptor<Date, T>;
+    addColumnBoolean(property: string, yes?: string, no?: string, asIcon?: boolean): ColumnDescriptor<boolean, T>;
+    addColumnEnum(property: string, enumType: EnumType, nameAsValue?: boolean, titlePath?: string | null): ColumnDescriptor<EnumType, T>;
+    addColumnCustomComponent(property: string, customComponentType: Type<IColumnValueComponent<T>>): ColumnDescriptor<any, T>;
+    createTabGroup(name: string, title?: string): this;
+    createFieldGroup(name: string, title?: string): this;
+    addFieldDescriptor<FT>(field: AFieldDescriptor<FT, T>): this;
+    addField(property: string): FieldInputDescriptor<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>;
+    copy(): TableviewDescriptor<T>;
+}
+export declare class TableviewAutoDescriptor<T> extends TableviewDescriptor<T> {
+    protected _table: TableAutoDescriptor<T>;
+    protected _editEditor: EditorAutoDescriptor<T>;
+    protected _viewEditor: EditorAutoDescriptor<T>;
+    protected _addEditor: EditorAutoDescriptor<T>;
+    private _attributes;
+    private constructor();
+    get table(): TableAutoDescriptor<T>;
+    /*******
+     * Static builders
+     *******/
+    /**
+     * generates full descriptor with all fields defined in attributes field (OpenApi specification) EXCEPT class type field
+     */
+    static generateFrom<T>(modelType: ClassType<T>, idProperty?: string, titleProperty?: string): TableviewAutoDescriptor<T>;
+    /**
+     * defines and overrides table descriptor
+     * @param tableDescriptor
+     */
+    withCustomTableDescriptor(tableDescriptor: TableAutoDescriptor<T>): this;
+    /**
+     * defines and overrides one or all editor descriptor
+     * @param editorDescriptor
+     * @param tableviewType if not provided all editor descriptors will be updated (add, edit, view)
+     */
+    withCustomEditorDescriptor(editorDescriptor: EditorAutoDescriptor<T>, tableviewType?: TableviewTypeEnum | 'all'): this;
+    /**
+     * creates column and field with custom type, for example currency
+     * if field exists, it is replaced
+     * DO NOT USE WITH TYPES WHERE ARGS ARE REQUIRED - ERROR WILL BE THROWN
+     * for enum use withEnumType
+     * for custom class use withClassType
+     * @param property name of field
+     * @param columnType required column type
+     * @param fieldType optional, if not provided it is converted from column type
+     */
+    withModifiedType(property: string, columnType: ColumnTypeEnum, fieldType?: FieldInputTypeEnum): this;
+    /**
+     * creates column with enum type
+     * if fields exists, it is replaced
+     * @param property property name
+     * @param enumType type of enum
+     * @param fieldType type of field, optional, default is Text
+     */
+    withCustomEnumType(property: string, enumType?: EnumType, fieldType?: FieldInputTypeEnum): this;
+    /**
+     * generates column with custom class type
+     * field is generated only if lookupProvider is provided
+     * @param property property name
+     * @param modelType class type of object
+     * @param titleProperty
+     * @param lookupProvider
+     * @param itemsLabelProperty
+     * @param filterProperty
+     */
+    withCustomClassType<MT>(property: string, modelType?: ClassType<MT>, lookupProvider?: ILookupDataProvider<MT, any>, titleProperty?: string, itemsLabelProperty?: string, filterProperty?: string): this;
+}
+export declare class TableviewDynamicDescriptor extends TableviewDescriptor<any> {
+    protected _table: TableDynamicDescriptor;
+    constructor(table?: TableDynamicDescriptor, idProperty?: string, titleProperty?: string);
+    get table(): TableDynamicDescriptor;
+    /**
+     * sets custom table descriptor
+     * @param descriptor
+     */
+    withTableDescriptor(descriptor: TableDynamicDescriptor): this;
+    /**
+     * sets visibility hidden state to column with given property
+     * equals to be removing in auto and base tableview descriptor
+     * * @param property column's property
+     */
+    removeColumn(property: string): this;
+    /**
+     * creates depp copy of tableview object and its children
+     */
+    copy(): TableviewDynamicDescriptor;
+}

package/lib/descriptors/types/action.type.d.ts

@@ -1,45 +1,45 @@
-export declare enum ActionPositionEnum {
-    ToolbarLeft = 0,
-    ToolbarRight = 1,
-    TableHeader = 2,
-    RowInline = 3,
-    RowClick = 4,
-    FooterLeft = 5,
-    FooterRight = 6
-}
-export declare enum ActionActivationTriggerEnum {
-    OnClick = 0,
-    OnRoute = 1
-}
-export declare enum ActionTypeEnum {
-    Direct = 0,
-    Editor = 1
-}
-export declare enum ActionLevelEnum {
-    Default = 0,
-    Primary = 1,
-    Secondary = 2,
-    Info = 3,
-    Help = 4,
-    Success = 5,
-    Warning = 6,
-    Danger = 7
-}
-export declare enum ActionSizeEnum {
-    ExtraSmall = 0,
-    Small = 1,
-    Normal = 2,
-    Large = 3,
-    ExtraLarge = 4
-}
-export declare enum ActionEditorDialogSizeEnum {
-    ExtraSmall = 0,
-    Small = 1,
-    Normal = 2,
-    Large = 3,
-    ExtraLarge = 4
-}
-export declare enum ActionEditorSubmitTypeEnum {
-    Submit = 0,
-    Cancel = 1
-}
+export declare enum ActionPositionEnum {
+    ToolbarLeft = 0,
+    ToolbarRight = 1,
+    TableHeader = 2,
+    RowInline = 3,
+    RowClick = 4,
+    FooterLeft = 5,
+    FooterRight = 6
+}
+export declare enum ActionActivationTriggerEnum {
+    OnClick = 0,
+    OnRoute = 1
+}
+export declare enum ActionTypeEnum {
+    Direct = 0,
+    Editor = 1
+}
+export declare enum ActionLevelEnum {
+    Default = 0,
+    Primary = 1,
+    Secondary = 2,
+    Info = 3,
+    Help = 4,
+    Success = 5,
+    Warning = 6,
+    Danger = 7
+}
+export declare enum ActionSizeEnum {
+    ExtraSmall = 0,
+    Small = 1,
+    Normal = 2,
+    Large = 3,
+    ExtraLarge = 4
+}
+export declare enum ActionEditorDialogSizeEnum {
+    ExtraSmall = 0,
+    Small = 1,
+    Normal = 2,
+    Large = 3,
+    ExtraLarge = 4
+}
+export declare enum ActionEditorSubmitTypeEnum {
+    Submit = 0,
+    Cancel = 1
+}

package/lib/descriptors/types/column.type.d.ts

@@ -1,9 +1,9 @@
-export declare enum ColumnTypeEnum {
-    String = 0,
-    Number = 1,
-    Currency = 2,
-    Boolean = 3,
-    Date = 4,
-    Enum = 5,
-    Custom = 6
-}
+export declare enum ColumnTypeEnum {
+    String = 0,
+    Number = 1,
+    Currency = 2,
+    Boolean = 3,
+    Date = 4,
+    Enum = 5,
+    Custom = 6
+}

package/lib/descriptors/types/editor.type.d.ts

@@ -1,6 +1,6 @@
-export declare enum TableviewTypeEnum {
-    None = 0,
-    View = 1,
-    Edit = 2,
-    Add = 3
-}
+export declare enum TableviewTypeEnum {
+    None = 0,
+    View = 1,
+    Edit = 2,
+    Add = 3
+}

package/lib/descriptors/types/field.type.d.ts

@@ -1,44 +1,44 @@
-export declare enum FieldSizeEnum {
-    Small = 0,
-    Normal = 1,
-    Large = 2
-}
-export declare enum FieldInputTypeEnum {
-    Hidden = 0,
-    Label = 1,
-    Text = 2,
-    Textarea = 3,
-    Number = 4,
-    Currency = 5,
-    Switch = 6,
-    Radio = 7,
-    Datepicker = 8,
-    Mask = 9,
-    File = 10,
-    Custom = 11
-}
-export declare enum FieldLookupTypeEnum {
-    Dropdown = 0,
-    Autocomplete = 1,
-    Dialog = 2
-}
-export declare enum FieldManyToManyEditorTypeEnum {
-    DialogTableMultiselect = 0
-}
-export declare enum FieldManyToManyEditorActionEnum {
-    Add = 0,
-    Delete = 1
-}
-export declare enum FieldManyEditorTypeEnum {
-    DialogEditor = 0
-}
-export declare enum FieldManyEditorActionEnum {
-    View = 0,
-    Add = 1,
-    Edit = 2,
-    Delete = 3
-}
-export declare enum FieldGroupTypeEnum {
-    Fieldset = 0,
-    Logical = 1
-}
+export declare enum FieldSizeEnum {
+    Small = 0,
+    Normal = 1,
+    Large = 2
+}
+export declare enum FieldInputTypeEnum {
+    Hidden = 0,
+    Label = 1,
+    Text = 2,
+    Textarea = 3,
+    Number = 4,
+    Currency = 5,
+    Switch = 6,
+    Radio = 7,
+    Datepicker = 8,
+    Mask = 9,
+    File = 10,
+    Custom = 11
+}
+export declare enum FieldLookupTypeEnum {
+    Dropdown = 0,
+    Autocomplete = 1,
+    Dialog = 2
+}
+export declare enum FieldManyToManyEditorTypeEnum {
+    DialogTableMultiselect = 0
+}
+export declare enum FieldManyToManyEditorActionEnum {
+    Add = 0,
+    Delete = 1
+}
+export declare enum FieldManyEditorTypeEnum {
+    DialogEditor = 0
+}
+export declare enum FieldManyEditorActionEnum {
+    View = 0,
+    Add = 1,
+    Edit = 2,
+    Delete = 3
+}
+export declare enum FieldGroupTypeEnum {
+    Fieldset = 0,
+    Logical = 1
+}

package/lib/descriptors/types/filter.type.d.ts

@@ -1,27 +1,27 @@
-export declare enum FilterTypeEnum {
-    String = 0,
-    Number = 1,
-    Boolean = 2,
-    Date = 3,
-    Lookup = 4,
-    LookupEnum = 5
-}
-export declare enum FilterMatchModeEnum {
-    StartsWith = "startsWith",
-    Contains = "contains",
-    EndsWith = "endsWith",
-    Equals = "equals",
-    NotEquals = "notEquals",
-    In = "in",
-    LessThan = "lt",
-    GreaterThan = "gt",
-    Between = "between",
-    DateIs = "dateIs",
-    DateIsNot = "dateIsNot",
-    DateBefore = "dateBefore",
-    DateAfter = "dateAfter"
-}
-export declare enum FilterLookupTypeEnum {
-    Dropdown = 0,
-    Autocomplete = 1
-}
+export declare enum FilterTypeEnum {
+    String = 0,
+    Number = 1,
+    Boolean = 2,
+    Date = 3,
+    Lookup = 4,
+    LookupEnum = 5
+}
+export declare enum FilterMatchModeEnum {
+    StartsWith = "startsWith",
+    Contains = "contains",
+    EndsWith = "endsWith",
+    Equals = "equals",
+    NotEquals = "notEquals",
+    In = "in",
+    LessThan = "lt",
+    GreaterThan = "gt",
+    Between = "between",
+    DateIs = "dateIs",
+    DateIsNot = "dateIsNot",
+    DateBefore = "dateBefore",
+    DateAfter = "dateAfter"
+}
+export declare enum FilterLookupTypeEnum {
+    Dropdown = 0,
+    Autocomplete = 1
+}

package/lib/descriptors/types/index.d.ts

@@ -1,6 +1,6 @@
-export * from './action.type';
-export * from './column.type';
-export * from './editor.type';
-export * from './field.type';
-export * from './filter.type';
-export * from './table.type';
+export * from './action.type';
+export * from './column.type';
+export * from './editor.type';
+export * from './field.type';
+export * from './filter.type';
+export * from './table.type';

package/lib/descriptors/types/table.type.d.ts

@@ -1,13 +1,13 @@
-export declare enum TablePaginationModeEnum {
-    Pagination = 0,
-    InfiniteScroll = 1
-}
-export declare enum TableFilterDisplayEnum {
-    Row = 0,
-    Menu = 1
-}
-export declare enum TableSizeEnum {
-    Small = 0,
-    Normal = 1,
-    Large = 2
-}
+export declare enum TablePaginationModeEnum {
+    Pagination = 0,
+    InfiniteScroll = 1
+}
+export declare enum TableFilterDisplayEnum {
+    Row = 0,
+    Menu = 1
+}
+export declare enum TableSizeEnum {
+    Small = 0,
+    Normal = 1,
+    Large = 2
+}

package/lib/descriptors/types/tableview-attr.model.d.ts

@@ -0,0 +1,9 @@
+import { AttributeDef } from '../../api/models';
+import { ClassType, EnumType } from '../../types';
+import { ColumnTypeEnum, FieldInputTypeEnum } from './index';
+export interface TableviewAttributeDef extends AttributeDef {
+    columnType: ColumnTypeEnum;
+    fieldType?: FieldInputTypeEnum;
+    enumType?: EnumType;
+    classType?: ClassType<any>;
+}

package/lib/directives/component.directive.d.ts

@@ -1,16 +1,16 @@
-import { ComponentRef, OnInit, Type, ViewContainerRef } from '@angular/core';
-import * as i0 from "@angular/core";
-export declare class MngComponentDirective<C> implements OnInit {
-    viewContainerRef: ViewContainerRef;
-    component: Type<C>;
-    inputs?: {
-        [key: string]: any;
-    };
-    private componentInstanceEventEmitter;
-    componentRef: ComponentRef<C>;
-    constructor(viewContainerRef: ViewContainerRef);
-    ngOnInit(): void;
-    private isCmpInstanceOfColumnValue;
-    static ɵfac: i0.ɵɵFactoryDeclaration<MngComponentDirective<any>, never>;
-    static ɵdir: i0.ɵɵDirectiveDeclaration<MngComponentDirective<any>, "[mngComponent]", never, { "component": "mngComponent"; "inputs": "inputs"; }, { "componentInstanceEventEmitter": "instanceCreated"; }, never, never, false>;
-}
+import { ComponentRef, OnInit, Type, ViewContainerRef } from '@angular/core';
+import * as i0 from "@angular/core";
+export declare class MngComponentDirective<C> implements OnInit {
+    viewContainerRef: ViewContainerRef;
+    component: Type<C>;
+    inputs?: {
+        [key: string]: any;
+    };
+    private componentInstanceEventEmitter;
+    componentRef: ComponentRef<C>;
+    constructor(viewContainerRef: ViewContainerRef);
+    ngOnInit(): void;
+    private isCmpInstanceOfColumnValue;
+    static ɵfac: i0.ɵɵFactoryDeclaration<MngComponentDirective<any>, never>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<MngComponentDirective<any>, "[mngComponent]", never, { "component": "mngComponent"; "inputs": "inputs"; }, { "componentInstanceEventEmitter": "instanceCreated"; }, never, never, false>;
+}

package/lib/directives/index.d.ts

@@ -1,2 +1,2 @@
-export * from './component.directive';
-export * from './template.directive';
+export * from './component.directive';
+export * from './template.directive';

package/lib/directives/template.directive.d.ts

@@ -1,13 +1,13 @@
-import { TemplateRef, ViewContainerRef } from '@angular/core';
-import * as i0 from "@angular/core";
-export declare class MngTemplateDirective {
-    template: TemplateRef<any>;
-    private viewContainerRef;
-    type: string;
-    name: string;
-    constructor(template: TemplateRef<any>, viewContainerRef: ViewContainerRef);
-    getType(): string;
-    getViewContainerRef(): ViewContainerRef;
-    static ɵfac: i0.ɵɵFactoryDeclaration<MngTemplateDirective, never>;
-    static ɵdir: i0.ɵɵDirectiveDeclaration<MngTemplateDirective, "[mngTemplate]", never, { "type": "type"; "name": "mngTemplate"; }, {}, never, never, false>;
-}
+import { TemplateRef, ViewContainerRef } from '@angular/core';
+import * as i0 from "@angular/core";
+export declare class MngTemplateDirective {
+    template: TemplateRef<any>;
+    private viewContainerRef;
+    type: string;
+    name: string;
+    constructor(template: TemplateRef<any>, viewContainerRef: ViewContainerRef);
+    getType(): string;
+    getViewContainerRef(): ViewContainerRef;
+    static ɵfac: i0.ɵɵFactoryDeclaration<MngTemplateDirective, never>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<MngTemplateDirective, "[mngTemplate]", never, { "type": "type"; "name": "mngTemplate"; }, {}, never, never, false>;
+}