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

package/tableview/api/class/index.d.ts

@@ -1,10 +1,141 @@
-export * from './editor/class-editor-attribute.model';
-export * from './editor/class-editor-attribute-converter';
-export * from './editor/class-editor-data-provider.factory';
-export * from './editor/class-editor-descriptor.factory';
-export * from './editor/class-editor-descriptor-helpers';
-export * from './tableview/class-tableview-attribute.model';
-export * from './tableview/class-tableview-attribute-converter';
-export * from './tableview/class-tableview-descriptor.factory';
-export * from './tableview/class-tableview-descriptor-helpers';
-export * from './tableview/class-tableview-data-provider.factory';
+import { ClassAttributeDef, ClassType, EnumType, ServiceClassType, ILookupDataProvider } from '@mediusinc/mng-commons/core';
+import { FieldInputTypeEnum, EditorDataProviderInst, EditorDescriptorCreateOptsType, EditorDescriptorInst, AFieldDescriptor, FieldLookupDescriptor, TableviewDescriptorCreateMultiModelWithModelDescriptorOptsType, TableviewDescriptorInst, TableviewDataProviderInst } from '@mediusinc/mng-commons/tableview/api';
+import { ColumnTypeEnum, ColumnDisplayTypeEnum } from '@mediusinc/mng-commons/table/api';
+import { EnumDescriptor } from '@mediusinc/mng-commons/model';
+import { TableClassAttributeDef } from '@mediusinc/mng-commons/table/api/class';
+
+interface EditorClassAttributeDef extends ClassAttributeDef {
+    classType?: ClassType<any>;
+    fieldType?: FieldInputTypeEnum;
+    enumType?: EnumType;
+}
+
+/**
+ * converts string type to type enum, default is text
+ * @param attributeType
+ */
+declare function getFieldInputTypeFromClassAttributeDefType(attributeType: string): FieldInputTypeEnum;
+/**
+ * convert column type to equivalent field input type
+ * @param type column type
+ * @param displayType column display type
+ */
+declare function getFieldInputTypeFromColumnType(type: ColumnTypeEnum, displayType?: ColumnDisplayTypeEnum): FieldInputTypeEnum;
+declare function expandClassAttributeDefWithEditorDef(attributes?: Array<ClassAttributeDef> | null): EditorClassAttributeDef[];
+/**
+ * returns attributes from class type and extends to typed def with column and field enum type
+ * @param type class type
+ */
+declare function getEditorClassAttributeDef<T>(type: ClassType<T>): EditorClassAttributeDef[];
+
+declare function editorDataProviderFromClass<Model>(type: ClassType<Model>): EditorDataProviderInst<Model, undefined, undefined>;
+declare function editorDataProviderFromClass<Model, Service = any>(type: ClassType<Model>, serviceType: ServiceClassType<Service>): EditorDataProviderInst<Model, Service, ServiceClassType<Service>>;
+
+declare function editorDescriptorFromClass<EditorModel, ParentEditorModel = undefined>(type: ClassType<EditorModel>, opts?: EditorDescriptorCreateOptsType<EditorModel, ParentEditorModel>): EditorDescriptorInst<EditorModel, ParentEditorModel>;
+/**
+ * Generates descriptor based on type attribute definition
+ * @param type class type
+ * @param attributes
+ * @param opts
+ */
+declare function editorDescriptorFromClassAttrsDef<EditorModel, ParentEditorModel = undefined>(type: ClassType<EditorModel>, attributes?: EditorClassAttributeDef[], opts?: EditorDescriptorCreateOptsType<EditorModel, ParentEditorModel>): EditorDescriptorInst<EditorModel, ParentEditorModel>;
+
+/**
+ * Generates field based on attribute definition, used for auto model
+ * @param descriptor Editor descriptor instance.
+ * @param attribute Attribute definition.
+ * @param field Optional, if defined will be replaced, otherwise new will be generated.
+ * @param args Optional additional arguments mapped to filed type. Arguments depend on possible arguments on fields.
+ * @internal
+ */
+declare function upsertEditorFieldFromAttributeDef<T>(descriptor: EditorDescriptorInst<T, any>, attribute: EditorClassAttributeDef, field?: AFieldDescriptor<any, T>, ...args: any[]): AFieldDescriptor<any, T>;
+/**
+ * Modifies selected field by field property. For enums use {withFieldModifiedEnum} instead.
+ * @param descriptor Editor descriptor.
+ * @param property Model's property name.
+ * @param fieldType new field type for selected field
+ * @param args additional parameters for field
+ */
+declare function modifyEditorClassAttributeFieldType<EditorModel, Property extends keyof EditorModel, FieldModel = NonNullable<EditorModel[Property]>, FieldValue = EditorModel[Property]>(descriptor: EditorDescriptorInst<EditorModel, any>, property: Property, fieldType: FieldInputTypeEnum, ...args: any[]): AFieldDescriptor<FieldModel, EditorModel, FieldValue> | null;
+declare function modifyEditorClassAttributeFieldTypeUnsafe<EditorModel, FieldModel = any, FieldValue = FieldModel>(descriptor: EditorDescriptorInst<EditorModel, any>, property: string, fieldType: FieldInputTypeEnum, ...args: any[]): AFieldDescriptor<FieldModel, EditorModel, FieldValue> | null;
+/**
+ * Modifies selected field with enum type.
+ * @param descriptor Editor descriptor.
+ * @param property Model's property name.
+ * @param enumModel Enum descriptor.
+ * @param values
+ */
+declare function modifyEditorClassAttributeFieldEnum<EditorModel, Property extends keyof EditorModel, Enum extends NonNullable<EditorModel[Property]>, FieldModel = NonNullable<EditorModel[Property]>, FieldValue = EditorModel[Property]>(descriptor: EditorDescriptorInst<EditorModel, any>, property: Property, enumModel?: EnumDescriptor<Enum>, values?: Array<Enum>): AFieldDescriptor<FieldModel, EditorModel, FieldValue> | null;
+declare function modifyEditorClassAttributeFieldEnumUnsafe<EditorModel, Enum = any, FieldModel = any, FieldValue = FieldModel>(descriptor: EditorDescriptorInst<EditorModel, any>, property: string, enumDesc?: EnumDescriptor<Enum>, values?: Array<Enum>): AFieldDescriptor<FieldModel, EditorModel, FieldValue> | null;
+/**
+ * Modifies selected field with lookup field.
+ * @param descriptor Editor descriptor.
+ * @param property Model's property name.
+ * @param lookupProvider provider to be added to field
+ * @param titleProperty
+ */
+declare function modifyEditorFieldLookup<EditorModel, Property extends keyof EditorModel, Service, FieldModel = NonNullable<EditorModel[Property]>, FieldValue = EditorModel[Property]>(descriptor: EditorDescriptorInst<EditorModel, any>, property: Property, lookupProvider: ILookupDataProvider<FieldModel, Service>, titleProperty?: keyof FieldModel): FieldLookupDescriptor<FieldModel, EditorModel, Service, FieldValue>;
+declare function modifyEditorFieldLookupUnsafe<EditorModel, Service, FieldModel = any, FieldValue = FieldModel>(descriptor: EditorDescriptorInst<EditorModel, any>, property: string, lookupProvider: ILookupDataProvider<FieldModel, Service>, titleProperty?: string): FieldLookupDescriptor<FieldModel, EditorModel, Service, FieldValue>;
+
+type TableviewClassAttributeDef = EditorClassAttributeDef & TableClassAttributeDef;
+
+declare function expandClassAttributeDefWithTableviewDef(attributes?: Array<ClassAttributeDef> | null): TableviewClassAttributeDef[];
+/**
+ * returns attributes from class type and extends to typed def with column and field enum type
+ * @param type class type
+ */
+declare function getTableviewClassAttributeDef<T>(type: ClassType<T>): TableviewClassAttributeDef[];
+
+declare function tableviewDescriptorFromClass<TableviewModel, Sorts = keyof TableviewModel, Filters = keyof TableviewModel, ParentEditorModel = undefined>(type: ClassType<TableviewModel>, opts?: TableviewDescriptorCreateMultiModelWithModelDescriptorOptsType<TableviewModel>): TableviewDescriptorInst<TableviewModel, Sorts, Filters, ParentEditorModel>;
+/**
+ * generates descriptor based on type attribute definition
+ * @param type class type
+ * @param columnAttributes
+ * @param fieldAttributes
+ * @param opts
+ */
+declare function tableviewDescriptorFromClassAttrsDef<TableviewModel, Sorts = keyof TableviewModel, Filters = keyof TableviewModel>(type: ClassType<TableviewModel>, columnAttributes?: TableviewClassAttributeDef[], fieldAttributes?: TableviewClassAttributeDef[] | null, opts?: TableviewDescriptorCreateMultiModelWithModelDescriptorOptsType<TableviewModel>): TableviewDescriptorInst<TableviewModel, Sorts, Filters>;
+
+/**
+ * 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 descriptor Tableview descriptor
+ * @param property name of field
+ * @param columnType required column type
+ * @param fieldType optional, if not provided it is converted from column type
+ * @param columnDisplayType optional
+ */
+declare function modifyTableviewClassAttributeType<TableviewModel>(descriptor: TableviewDescriptorInst<TableviewModel, any, any>, property: keyof TableviewModel, columnType: ColumnTypeEnum, fieldType?: FieldInputTypeEnum, columnDisplayType?: ColumnDisplayTypeEnum): boolean;
+declare function modifyTableviewClassAttributeTypeUnsafe<TableviewModel>(descriptor: TableviewDescriptorInst<TableviewModel, any, any>, property: string, columnType: ColumnTypeEnum, fieldType?: FieldInputTypeEnum, columnDisplayType?: ColumnDisplayTypeEnum): boolean;
+/**
+ * creates column with enum type
+ * if fields exists, it is replaced
+ * @param descriptor Tableview descriptor
+ * @param property property name
+ * @param enumDesc type of enum
+ * @param fieldType type of field, optional, default is Text
+ */
+declare function modifyTableviewClassAttributeEnum<TableviewModel, Property extends keyof TableviewModel, Enum extends NonNullable<TableviewModel[Property]>>(descriptor: TableviewDescriptorInst<TableviewModel, any, any>, property: Property, enumDesc?: EnumDescriptor<Enum>, fieldType?: FieldInputTypeEnum): boolean;
+declare function modifyTableviewClassAttributeEnumUnsafe<TableviewModel, Enum = any>(descriptor: TableviewDescriptorInst<TableviewModel, any, any>, property: string, enumDesc?: EnumDescriptor<Enum>, fieldType?: FieldInputTypeEnum): boolean;
+/**
+ * generates column with custom class type
+ * field is generated only if lookupProvider is provided
+ * @param descriptor Tableview descriptor
+ * @param property property name
+ * @param type class type of object
+ * @param titleProperty
+ * @param lookupProvider
+ * @param optionsLabelProperty
+ * @param filterProperty
+ */
+declare function modifyTableviewLookup<TableviewModel, Property extends keyof TableviewModel, LookupModel = NonNullable<TableviewModel[Property]>>(descriptor: TableviewDescriptorInst<TableviewModel, any, any>, property: Property, type?: ClassType<LookupModel>, lookupProvider?: ILookupDataProvider<LookupModel>, titleProperty?: keyof LookupModel, optionsLabelProperty?: keyof LookupModel, filterProperty?: keyof LookupModel): boolean;
+declare function modifyTableviewLookupUnsafe<TableviewModel, LookupModel>(descriptor: TableviewDescriptorInst<TableviewModel, any, any>, property: string, type?: ClassType<LookupModel>, lookupProvider?: ILookupDataProvider<LookupModel>, titleProperty?: string, optionsLabelProperty?: string, filterProperty?: string): boolean;
+
+declare function tableviewDataProviderFromClass<Model, Sorts = keyof Model, Filters extends keyof any = keyof Model>(type: ClassType<Model>): TableviewDataProviderInst<Model, undefined, Sorts, Filters, undefined>;
+declare function tableviewDataProviderFromClass<Model, Service = any, Sorts = keyof Model, Filters extends keyof any = keyof Model>(type: ClassType<Model>, serviceType: ServiceClassType<Service>): TableviewDataProviderInst<Model, Service, Sorts, Filters, ServiceClassType<Service>>;
+
+export { editorDataProviderFromClass, editorDescriptorFromClass, editorDescriptorFromClassAttrsDef, expandClassAttributeDefWithEditorDef, expandClassAttributeDefWithTableviewDef, getEditorClassAttributeDef, getFieldInputTypeFromClassAttributeDefType, getFieldInputTypeFromColumnType, getTableviewClassAttributeDef, modifyEditorClassAttributeFieldEnum, modifyEditorClassAttributeFieldEnumUnsafe, modifyEditorClassAttributeFieldType, modifyEditorClassAttributeFieldTypeUnsafe, modifyEditorFieldLookup, modifyEditorFieldLookupUnsafe, modifyTableviewClassAttributeEnum, modifyTableviewClassAttributeEnumUnsafe, modifyTableviewClassAttributeType, modifyTableviewClassAttributeTypeUnsafe, modifyTableviewLookup, modifyTableviewLookupUnsafe, tableviewDataProviderFromClass, tableviewDescriptorFromClass, tableviewDescriptorFromClassAttrsDef, upsertEditorFieldFromAttributeDef };
+export type { EditorClassAttributeDef, TableviewClassAttributeDef };