@mediusinc/mng-commons 1.4.0 → 2.0.0-rc.1-b808fba6

package/lib/descriptors/{editor.descriptor.d.ts → editor/editor.descriptor.d.ts}

@@ -1,116 +1,119 @@
-import { Observable } from 'rxjs';
-import { MediusQueryParam } from '../api/models';
-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;
-    protected _isLocalized: boolean;
-    protected _localizationLocaleProperty?: string;
-    protected _localizationLocalizationProperty?: string;
-    protected _localizationModelType?: ClassType<any>;
-    protected _localeLookup?: (queryParam?: MediusQueryParam, service?: any, search?: string) => Observable<Array<string>>;
-    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 tableviewEditorType(): TableviewEditorTypeEnum;
-    get disabled(): boolean;
-    get isLocalized(): boolean;
-    get localizationLocaleProperty(): string | undefined;
-    get localizationLocalizationProperty(): string | undefined;
-    get localizationBeanType(): ClassType<any> | undefined;
-    get localeLookup(): ((queryParam?: MediusQueryParam | undefined, service?: any, search?: string | undefined) => Observable<string[]>) | undefined;
-    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;
-    /**
-     * This method takes care of displaying correct/localized data in the editor
-     * @param localizationsProperty property that tells us where on the model are localizations accessible
-     * @param localeProperty property by which we find the locale
-     * @param localizationModelType model type for localizations if it is different from the whole model
-     * @param localeLookup lookup provider for locales supported by the application.
-     */
-    localized<S>(localizationsProperty?: string, localeProperty?: string, localizationModelType?: ClassType<any>, localeLookup?: (queryParam?: MediusQueryParam, service?: S, search?: string) => Observable<Array<string>>): this;
-}
+import { Observable } from 'rxjs';
+import { MediusQueryParam } from '../../api/models';
+import { ILookupDataProvider } from '../../data-providers';
+import { TableviewAttributeDef } from '../../models/tableview-attr.model';
+import { ClassType, EnumConstantType, EnumType, MngFieldValidationMessage, MngFieldValidator } from '../../types';
+import { ModelDescriptor } from '../model.descriptor';
+import { TableDescriptor } from '../table';
+import { TableviewDescriptor } from '../tableview';
+import { FieldInputTypeEnum, TableviewEditorTypeEnum } from '../types';
+import { AFieldDescriptor, FieldActionDescriptor, FieldGroupDescriptor, FieldInputDescriptor, FieldLookupDescriptor, FieldLookupEnumDescriptor, FieldManyEditorDescriptor, FieldManyToManyEditorDescriptor, FieldTabGroupDescriptor } from './field.descriptor';
+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;
+    protected _isLocalized: boolean;
+    protected _localizationLocaleProperty?: string;
+    protected _localizationLocalizationProperty?: string;
+    protected _localizationModelType?: ClassType<any>;
+    protected _localeLookup?: (queryParam?: MediusQueryParam, service?: any, search?: string) => Observable<Array<string>>;
+    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 tableviewEditorType(): TableviewEditorTypeEnum;
+    get disabled(): boolean;
+    get isLocalized(): boolean;
+    get localizationLocaleProperty(): string | undefined;
+    get localizationLocalizationProperty(): string | undefined;
+    get localizationBeanType(): ClassType<any> | undefined;
+    get localeLookup(): ((queryParam?: MediusQueryParam | undefined, service?: any, search?: string | undefined) => Observable<string[]>) | undefined;
+    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;
+    /**
+     * This method takes care of displaying correct/localized data in the editor
+     * @param localizationsProperty property that tells us where on the model are localizations accessible
+     * @param localeProperty property by which we find the locale
+     * @param localizationModelType model type for localizations if it is different from the whole model
+     * @param localeLookup lookup provider for locales supported by the application.
+     */
+    localized<S>(localizationsProperty?: string, localeProperty?: string, localizationModelType?: ClassType<any>, localeLookup?: (queryParam?: MediusQueryParam, service?: S, search?: string) => Observable<Array<string>>): this;
+}

package/lib/descriptors/{field-validation.descriptor.d.ts → editor/field-validation.descriptor.d.ts}

@@ -1,19 +1,19 @@
-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;
-    copy(): FieldValidationDescriptor;
-}
+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;
+    copy(): FieldValidationDescriptor;
+}