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

package/tableview/index.d.ts

@@ -1,6 +1,510 @@
-export * from './schema/columns-from-schema';
-export * from './schema/enum-from-schema';
-export * from './schema/fields-from-schema';
-export * from './helpers/lookup-get-all-create';
-export * from './helpers/tableview-get-all-params-create';
-export * from './filter/generic-filters';
+import { SchemaModel, SchemaEnum, SchemaProperty, GetAllHttpResponseType, ExtractGetAllParamsFilterType, ApiServiceGetAllFilterType, ExtractGetAllParamsSortType, ExtractServiceGetAllDataType, GetAllParamsDefaultWoFiltersType } from '@mediusinc/mng-commons-data-api';
+import * as _mediusinc_mng_commons_core from '@mediusinc/mng-commons/core';
+import { GetterFn, ArrayItemType, ClassFunctionKeysWithAnyArgsAndReturnType, ServiceClassType, FilterMatchModeExtendedType, DataListSort, ItemOrObservable, ClassFunctionKeysWithReturnType, ClassFunctionKeysWithParamAndReturnType } from '@mediusinc/mng-commons/core';
+import { EnumDescriptor, ModelDescriptor, TypeDescriptor } from '@mediusinc/mng-commons/model';
+import { TableDescriptorInst, ColumnDescriptor, ITableDataProvider } from '@mediusinc/mng-commons/table/api';
+import * as _mediusinc_mng_commons_tableview_api from '@mediusinc/mng-commons/tableview/api';
+import { TableviewDescriptorInst, TableviewDescriptorFieldsManageMultiType, EditorDescriptorInst, FieldInputDescriptor, FieldLookupEnumDescriptor, FieldLookupProviderType, FieldManyEditorDescriptor, FieldManyToManyEditorDescriptor, AFieldDescriptor, TableviewInputBuilder, TableviewDataProviderInst, TableviewDescriptorInstConstructorOpts } from '@mediusinc/mng-commons/tableview/api';
+import { Observable, OperatorFunction } from 'rxjs';
+import { LookupDataProviderInst } from '@mediusinc/mng-commons/form/api';
+import { Type } from '@angular/core';
+import { FilterNumberOptsType, FilterDateOptsType, FilterTypeEnum, FilterGenericProperty } from '@mediusinc/mng-commons/filter';
+
+type ColumnType = 'number' | 'currency' | 'boolean' | 'string' | 'text' | 'textarea' | 'date' | 'date-time' | 'enum' | 'object';
+type ColumnFromSchemaCommonOptsType<Model> = {
+    currencyProperty?: keyof Model;
+    currency?: string;
+    currencyDisplay?: 'symbol' | 'code' | 'name';
+    dateFormat?: string;
+    dateTimeFormat?: string;
+    numberMinIntegerDigits?: number;
+    numberMinFractionDigits?: number;
+    numberMaxFractionDigits?: number;
+};
+type ColumnsFromSchemaOptsType<Model = any> = ColumnFromSchemaCommonOptsType<Model> & {
+    columnTypes?: Partial<Record<keyof Model, ColumnType>>;
+    enumModels?: Partial<Record<keyof Model, EnumDescriptor<any>>>;
+    enumSchemas?: Partial<Record<keyof Model, SchemaEnum<any>>>;
+    getters?: {
+        [K in keyof Model]?: GetterFn<Model[K], Model>;
+    };
+};
+type ColumnFromSchemaOptsType<Column = any, Model = any, Enum = any> = ColumnFromSchemaCommonOptsType<Model> & {
+    columnType?: ColumnType;
+    getter?: GetterFn<Column, Model>;
+    enumModel?: EnumDescriptor<Enum>;
+    enumSchema?: SchemaEnum<Enum>;
+};
+/**
+ * <em>Experimental:</em> Builder for adding columns to table.
+ *
+ * @experimental
+ */
+declare class SchemaColumnsBuilder<Model, SchModel = Model> {
+    private readonly descriptor;
+    private readonly schema;
+    private opts?;
+    constructor(descriptor: TableviewDescriptorInst<Model, any, any, any> | TableDescriptorInst<Model, any, any>, schema: SchemaModel<SchModel>, opts?: ColumnsFromSchemaOptsType<SchModel> | undefined);
+    private mergeColumnsOpts;
+    private mergeColumnOpts;
+    /**
+     * <em>Experimental:</em> Adds a single column via {addColumnFromSchema}.
+     *
+     * @experimental
+     *
+     * @param {Property} property - The property to add the column for.
+     * @param {ColumnFromSchemaOptsType<SchModel[Property], SchModel, any, Model>} opts - Additional options.
+     *
+     * @return {ColumnDescriptor<NonNullable<Model[Property]>, Model, Model[Property]>} The added column descriptor.
+     */
+    add<Property extends Extract<keyof Model, keyof SchModel>>(property: Property, opts?: ColumnFromSchemaOptsType<SchModel[Property], SchModel, any>): ColumnDescriptor<NonNullable<Model[Property]>, Model, Model[Property]>;
+    /**
+     * <em>Experimental:</em> Adds all columns from the non-array schema properties via {addColumnFromSchema}.
+     *
+     * @experimental
+     *
+     * @param {ColumnsFromSchemaOptsType<SchModel>} opts - Additional options.
+     *
+     * @return {this} - The current instance of the builder.
+     */
+    withAddAll(opts?: ColumnsFromSchemaOptsType<SchModel>): this;
+    /**
+     * <em>Experimental:</em> Adds columns for properties via {addColumnFromSchema}.
+     *
+     * @experimental
+     *
+     * @param {ColumnsFromSchemaOptsType<SchModel>} opts - Additional options.
+     * @param {...Property[]} properties - Properties to add columns for. If non provided, all non-array properties from schema will be added.
+     *
+     * @return {this} - The current instance of the builder.
+     */
+    withAdd<Property extends Extract<keyof Model, keyof SchModel>>(opts: ColumnsFromSchemaOptsType<SchModel>, ...properties: Property[]): this;
+    /**
+     * <em>Experimental:</em> Adds columns for properties via {addColumnFromSchema}.
+     *
+     * @experimental
+     *
+     * @param {...Property[]} properties - Properties to add columns for. If non provided, all non-array properties from schema will be added.
+     *
+     * @return {this} - The current instance of the builder.
+     */
+    withAdd<Property extends Extract<keyof Model, keyof SchModel>>(...properties: Property[]): this;
+    /**
+     * <em>Experimental:</em> Adds a single column via {addColumnFromSchema} where property schema is manually provided.
+     *
+     * @experimental
+     *
+     * @param {Property} property - The property to add the column for.
+     * @param {SchemaProperty} schemaProperty - Manually provided schema property.
+     * @param {ColumnFromSchemaOptsType} opts - Additional options.
+     *
+     * @return {ColumnDescriptor<NonNullable<Model[Property]>, Model, Model[Property]>} The added column descriptor.
+     */
+    addFromSchema<Property extends keyof Model>(property: Property, schemaProperty: SchemaProperty, opts?: ColumnFromSchemaOptsType<Model[Property], Model>): ColumnDescriptor<NonNullable<Model[Property]>, Model, Model[Property]>;
+    private addColumns;
+}
+/**
+ * <em>Experimental:</em> Creates builder for adding columns to descriptor based on provided model schema.
+ *
+ * @experimental
+ *
+ * @param {TableviewDescriptorInst<Model, any, any, any> | TableDescriptorInst<Model, any, any>} descriptor - Descriptor to add columns to.
+ * @param {SchemaModel<SchModel>} schema - The schema with metadata about properties for fields.
+ * @param {ColumnsFromSchemaOptsType<SchModel>} [opts] - Additional options.
+ *
+ * @return {SchemaColumnsBuilder<Model, SchModel>} - The column schema builder instance.
+ */
+declare function columnsFromSchema<Model, SchModel = Model>(descriptor: TableviewDescriptorInst<any, any, any, any, Model, any, any, any> | TableDescriptorInst<Model, any, any>, schema: SchemaModel<SchModel>, opts?: ColumnsFromSchemaOptsType<SchModel>): SchemaColumnsBuilder<Model, SchModel>;
+/**
+ * <em>Experimental:</em> Adds a column to table descriptor based on the given schema property and options.
+ *
+ * @param {TableviewDescriptorInst<Model, any, any, any> | TableDescriptorInst<Model, any, any>} descriptor - The table view descriptor or table descriptor to add the column to.
+ * @param {Property} property - The property key of the model to create the column for.
+ * @param {SchemaProperty} propertySchema - The schema property for the property.
+ * @param {ColumnFromSchemaOptsType<Model[Property], Model, any, Model>} [opts] - The options for the column.
+ *
+ * @return {ColumnDescriptor<NonNullable<Model[Property]>, Model, Model[Property]>} - The added column descriptor.
+ */
+declare function addColumnFromSchema<Property extends keyof TableModel, Model, TableModel = Model>(descriptor: TableviewDescriptorInst<Model, any, any, any, TableModel, any, any, any> | TableDescriptorInst<TableModel, any, any>, property: Property, propertySchema: SchemaProperty, opts?: ColumnFromSchemaOptsType<TableModel[Property], TableModel, any>): ColumnDescriptor<NonNullable<TableModel[Property]>, TableModel, TableModel[Property]>;
+
+/**
+ * <em>Experimental:</em> Emulates an enum model object from enum schema.
+ *
+ * @experimental
+ *
+ * @param {SchemaEnum<Enum>} enumSchema - The schema of the enum.
+ *
+ * @returns {EnumDescriptor<Enum>} - The generated enum model descriptor.
+ */
+declare function enumModelFromSchema<Enum>(enumSchema: SchemaEnum<Enum>): EnumDescriptor<Enum>;
+
+type FieldInputType = 'number' | 'currency' | 'boolean' | 'string' | 'text' | 'textarea' | 'date' | 'date-time' | 'enum' | 'hidden';
+type FromSchemaCommonOptsType<Model> = {
+    dateFormat?: string;
+    dateTimeFormat?: string;
+    textareaRows?: number;
+    numberUseGrouping?: boolean;
+    numberStep?: number;
+    numberMinFractionDigits?: number;
+    numberMaxFractionDigits?: number;
+    currency?: string;
+    currencyProperty?: keyof Model;
+    currencyDisplay?: 'symbol' | 'code' | 'name';
+};
+type FieldsFromSchemaOptsType<Model = any> = FromSchemaCommonOptsType<Model> & {
+    fieldTypes?: Partial<Record<keyof Model, FieldInputType>>;
+    enumModels?: Partial<Record<keyof Model, EnumDescriptor<any>>>;
+    enumSchemas?: Partial<Record<keyof Model, SchemaEnum<any>>>;
+};
+type FieldInputFromSchemaOptsType<Model = any, Enum = any> = FromSchemaCommonOptsType<Model> & {
+    fieldType?: FieldInputType;
+    enumSchema?: SchemaEnum<Enum>;
+    enumModel?: EnumDescriptor<Enum>;
+};
+/**
+ * <em>Experimental:</em> Builder for adding fields to editor.
+ *
+ * @experimental
+ */
+declare class SchemaFieldsBuilder<Model, Parent = unknown, AddModel = Model, EditModel = Model, FieldsModel = TableviewDescriptorFieldsManageMultiType<Model, AddModel, EditModel>, SchModel = Model> {
+    private readonly descriptor;
+    private readonly schema;
+    private opts?;
+    constructor(descriptor: TableviewDescriptorInst<Model, any, any, Parent, any, AddModel, EditModel, FieldsModel> | EditorDescriptorInst<FieldsModel, Parent>, schema: SchemaModel<SchModel>, opts?: FieldsFromSchemaOptsType<SchModel> | undefined);
+    private mergeFieldsInputOpts;
+    private mergeFieldInputOpts;
+    /**
+     * <em>Experimental:</em> Adds a single input field via {addFieldInputFromSchema}.
+     *
+     * @experimental
+     *
+     * @param {Property} property - The property to add the field for.
+     * @param {FieldInputFromSchemaOptsType<SchModel>} opts - Additional options.
+     *
+     * @return {FieldInputDescriptor<Model, NonNullable<Model[Property]>, Model[Property], Parent>} The added field descriptor.
+     */
+    add<Property extends Extract<keyof FieldsModel, keyof SchModel>>(property: Property, opts?: FieldInputFromSchemaOptsType<SchModel>): FieldInputDescriptor<FieldsModel, NonNullable<FieldsModel[Property]>, FieldsModel[Property], Parent>;
+    /**
+     * <em>Experimental:</em> Adds all input fields for the non-array properties via {addFieldInputFromSchema}.
+     *
+     * @experimental
+     *
+     * @param {FieldsFromSchemaOptsType<SchModel>} opts - Additional options.
+     *
+     * @return {this} - The current instance of the builder.
+     */
+    withAddAll(opts?: FieldsFromSchemaOptsType<SchModel>): this;
+    /**
+     * <em>Experimental:</em> Adds input fields for properties via {addFieldInputFromSchema}.
+     *
+     * @experimental
+     *
+     * @param {FieldsFromSchemaOptsType<SchModel>} opts - Additional options.
+     * @param {...Property[]} properties - Properties to add fields for. If non provided, all non-array properties from schema will be added.
+     *
+     * @return {this} - The current instance of the builder.
+     */
+    withAdd<PropertyKey extends Extract<keyof Model, keyof SchModel>>(opts: FieldsFromSchemaOptsType<SchModel>, ...properties: PropertyKey[]): this;
+    /**
+     * <em>Experimental:</em> Adds fields for properties via {addFieldInputFromSchema}.
+     *
+     * @experimental
+     *
+     * @param {...Property[]} properties - Properties to add fields for. If non provided, all non-array properties from schema will be added.
+     *
+     * @return {this} - The current instance of the builder.
+     */
+    withAdd<Property extends Extract<keyof FieldsModel, keyof SchModel>>(...properties: Property[]): this;
+    private addFields;
+    /**
+     * <em>Experimental:</em> Adds a single input field via {addFieldInputFromSchema} where property schema is manually provided.
+     *
+     * @experimental
+     *
+     * @param {Property} property - The property to add the field for.
+     * @param {SchemaProperty} schemaProperty - Manually provided schema property.
+     * @param {FieldInputFromSchemaOptsType<Model>} opts - Additional options.
+     *
+     * @return {FieldInputDescriptor<Model, NonNullable<Model[Property]>, Model[Property], Parent>} The added field descriptor.
+     */
+    addFromSchema<Property extends keyof FieldsModel>(property: Property, schemaProperty: SchemaProperty, opts?: FieldInputFromSchemaOptsType<FieldsModel>): FieldInputDescriptor<FieldsModel, NonNullable<FieldsModel[Property]>, FieldsModel[Property], Parent>;
+    /**
+     * <em>Experimental:</em> Adds an enum lookup field via {addFieldEnumLookupFromSchema}.
+     *
+     * @experimental
+     *
+     * @param {Property} property - The property to add the enum lookup field for.
+     * @param {SchemaEnum<Enum> | EnumDescriptor<Enum>} [enumOpt] - The enum schema or the enum model descriptor. If non provided, builder opts will be checked.
+     *
+     * @returns {FieldLookupEnumDescriptor<Enum, Model, Parent>} - The added field descriptor.
+     *
+     * @throws {CommonsInternalError} - If no enum metadata is found for the property either from parameter or from builder's opts.
+     */
+    addEnum<Property extends Extract<keyof FieldsModel, keyof SchModel>, Enum>(property: Property, enumOpt?: SchemaEnum<Enum> | EnumDescriptor<Enum>): FieldLookupEnumDescriptor<Enum, FieldsModel, Parent>;
+    /**
+     * <em>Experimental:</em> Adds an enum lookup field via {addFieldEnumLookupFromSchema} where property schema is manually provided.
+     *
+     * @experimental
+     *
+     * @param {Property} property - The property to add the enum lookup field for.
+     * @param {SchemaEnum<Enum> | EnumDescriptor<Enum>} [enumOpt] - The enum schema or the enum model descriptor. If non provided, builder opts will be checked.
+     * @param {SchemaProperty} schemaProperty - Manually provided schema property.
+     *
+     * @returns {FieldLookupEnumDescriptor<Enum, Model, Parent>} - The added field descriptor.
+     *
+     * @throws {CommonsInternalError} - If no enum metadata is found for the property either from parameter or from builder's opts.
+     */
+    addEnumFromSchema<Property extends keyof FieldsModel, Enum>(property: Property, enumOpt: SchemaEnum<Enum> | EnumDescriptor<Enum> | undefined, schemaProperty: SchemaProperty): FieldLookupEnumDescriptor<Enum, FieldsModel, Parent>;
+    /**
+     * <em>Experimental:</em> Adds a lookup field.
+     * {EditorDescriptorInt.addFieldLookup} is used to create field and ${setFieldBasicOptionsFromSchema} to add basic field's options from schema.
+     *
+     * @experimental
+     *
+     * @param {Property} property - The property to create the lookup field for.
+     * @param {FieldLookupProviderType<LookupModel, Service>} provider - Data provider for the lookup field.
+     *
+     * @return The created lookup field.
+     */
+    addLookup<Property extends Extract<keyof FieldsModel, keyof SchModel>, Service = undefined, LookupModel extends NonNullable<FieldsModel[Property]> = NonNullable<FieldsModel[Property]>>(property: Property, provider?: FieldLookupProviderType<LookupModel, Service>): _mediusinc_mng_commons_tableview_api.FieldLookupDescriptor<LookupModel, FieldsModel, Service, FieldsModel[Property], Parent, keyof LookupModel, keyof LookupModel>;
+    /**
+     * <em>Experimental:</em> Adds a lookup field where property schema is manually provided.
+     * {EditorDescriptorInt.addFieldLookup} is used to create field and ${setFieldBasicOptionsFromSchema} to add basic field's options from schema.
+     *
+     * @experimental
+     *
+     * @param {Property} property - The property to create the lookup field for.
+     * @param {FieldLookupProviderType<LookupModel, Service> | undefined} provider - Data provider for the lookup field.
+     * @param {SchemaProperty} schemaProperty - Manually provided schema property.
+     *
+     * @return The created lookup field.
+     */
+    addLookupFromSchema<Property extends keyof FieldsModel, Service = undefined, LookupModel extends NonNullable<FieldsModel[Property]> = NonNullable<FieldsModel[Property]>>(property: Property, provider: FieldLookupProviderType<LookupModel, Service> | undefined, schemaProperty: SchemaProperty): _mediusinc_mng_commons_tableview_api.FieldLookupDescriptor<LookupModel, FieldsModel, Service, FieldsModel[Property], Parent, keyof LookupModel, keyof LookupModel>;
+    /**
+     * <em>Experimental:</em> Adds a one-to-many editor field.
+     * {EditorDescriptorInt.addFieldManyEditor} is used to create field and ${setFieldBasicOptionsFromSchema} to add basic field's options from schema.
+     *
+     * @experimental
+     *
+     * @param {Property} property - The property to create the many editor field for.
+     * @param {TableviewDescriptorInst<FieldModel, any, any, FieldsModel>} tableviewDescriptor - Tableview descriptor.
+     *
+     * @return The created one-to-many editor field.
+     */
+    addManyEditor<Property extends Extract<keyof FieldsModel, keyof SchModel>, FieldModel = ArrayItemType<FieldsModel[Property]>, FieldValue = FieldsModel[Property]>(property: Property, tableviewDescriptor: TableviewDescriptorInst<FieldModel, any, any, FieldsModel, FieldModel, FieldModel, FieldModel, FieldModel>): FieldManyEditorDescriptor<FieldModel, FieldsModel, FieldValue, Parent>;
+    /**
+     * <em>Experimental:</em> Adds an one-to-many editor field where property schema is manually provided.
+     * {EditorDescriptorInt.addFieldManyEditor} is used to create field and ${setFieldBasicOptionsFromSchema} to add basic field's options from schema.
+     *
+     * @experimental
+     *
+     * @param {Property} property - The property to create the many editor field for.
+     * @param {TableviewDescriptorType<FieldModel, any, any, FieldsModel>} tableviewDescriptor - Tableview descriptor.
+     * @param {SchemaProperty} schemaProperty - Manually provided schema property.
+     *
+     * @return The created one-to-many editor field.
+     */
+    addManyEditorFromSchema<Property extends keyof FieldsModel, FieldModel = ArrayItemType<FieldsModel[Property]>, FieldValue = FieldsModel[Property]>(property: Property, tableviewDescriptor: TableviewDescriptorInst<FieldModel, any, any, FieldsModel, FieldModel, FieldModel, FieldModel, FieldModel>, schemaProperty: SchemaProperty): FieldManyEditorDescriptor<FieldModel, FieldsModel, FieldValue, Parent>;
+    /**
+     * <em>Experimental:</em> Adds a many-to-many editor field.
+     * {EditorDescriptorInt.addFieldManyToManyEditor} is used to create field and ${setFieldBasicOptionsFromSchema} to add basic field's options from schema.
+     *
+     * @experimental
+     *
+     * @param {Property} property - The property to create the many editor field for.
+     * @param {TableDescriptorInst<FieldModel>} mainTableDescriptor - Main table descriptor.
+     * @param {TableDescriptorInst<FieldModel>} lookupTableDescriptor - Lookup table descriptor.
+     * @param {ITableDataProvider<FieldModel, ServiceType>} lookupDataProvider - Lookup data provider.
+     *
+     * @return The created many-to-many editor field.
+     */
+    addManyToManyEditor<Property extends Extract<keyof FieldsModel, keyof SchModel>, ServiceType, FieldModel = ArrayItemType<FieldsModel[Property]>, FieldValue = FieldsModel[Property]>(property: Property, mainTableDescriptor: TableDescriptorInst<FieldModel>, lookupTableDescriptor: TableDescriptorInst<FieldModel>, lookupDataProvider: ITableDataProvider<FieldModel, ServiceType>): FieldManyToManyEditorDescriptor<FieldModel, FieldsModel, ServiceType, FieldValue, Parent>;
+    /**
+     * <em>Experimental:</em> Adds a many-to-many editor field where property schema is manually provided.
+     * {EditorDescriptorInt.addFieldManyToManyEditor} is used to create field and ${setFieldBasicOptionsFromSchema} to add basic field's options from schema.
+     *
+     * @experimental
+     *
+     * @param {Property} property - The property to create the many editor field for.
+     * @param {TableDescriptorInst<FieldModel>} mainTableDescriptor - Main table descriptor.
+     * @param {TableDescriptorInst<FieldModel>} lookupTableDescriptor - Lookup table descriptor.
+     * @param {ITableDataProvider<FieldModel, ServiceType>} lookupDataProvider - Lookup data provider.
+     * @param {SchemaProperty} schemaProperty - Manually provided schema property.
+     *
+     * @return The created many-to-many editor field.
+     */
+    addManyToManyEditorFromSchema<Property extends keyof FieldsModel, ServiceType, FieldModel = ArrayItemType<FieldsModel[Property]>, FieldValue = FieldsModel[Property]>(property: Property, mainTableDescriptor: TableDescriptorInst<FieldModel>, lookupTableDescriptor: TableDescriptorInst<FieldModel>, lookupDataProvider: ITableDataProvider<FieldModel, ServiceType>, schemaProperty: SchemaProperty): FieldManyToManyEditorDescriptor<FieldModel, FieldsModel, ServiceType, FieldValue, Parent>;
+}
+/**
+ * <em>Experimental:</em> Creates builder for adding fields to descriptor based on provided model schema.
+ *
+ * @experimental
+ *
+ * @param {TableviewDescriptorInst<Model, any, any, Parent, any, AddModel, EditModel, FieldsModel> | EditorDescriptorInst<Model, Parent>} descriptor - Descriptor to add fields to.
+ * @param {SchemaModel<SchModel>} schema - The schema with metadata about properties for fields.
+ * @param {FieldsFromSchemaOptsType<SchModel>} [opts] - Additional options.
+ *
+ * @return {SchemaFieldsBuilder<Model, Parent, AddModel, EditModel , FieldsModel, SchModel>} - The SchemaFieldsBuilder object containing the extracted fields.
+ */
+declare function fieldsFromSchema<Model, Parent = undefined, AddModel = Model, EditModel = Model, FieldsModel = TableviewDescriptorFieldsManageMultiType<Model, AddModel, EditModel>, SchModel = Model>(descriptor: TableviewDescriptorInst<Model, any, any, Parent, any, AddModel, EditModel, FieldsModel> | EditorDescriptorInst<FieldsModel, Parent>, schema: SchemaModel<SchModel>, opts?: FieldsFromSchemaOptsType<SchModel>): SchemaFieldsBuilder<Model, Parent, AddModel, EditModel, FieldsModel, SchModel>;
+/**
+ * <em>Experimental:</em> Adds a field input to editor descriptor based on the given schema property and options.
+ *
+ * @experimental
+ *
+ * @param {TableviewDescriptorInst | EditorDescriptorInst} descriptor - Descriptor to add field to.
+ * @param {keyof Model} property - The property of the model.
+ * @param {SchemaProperty} propertySchema - The property's schema for the field.
+ * @param {FieldInputFromSchemaOptsType<Model>} [opts] - Additional options.
+ *
+ * @return {FieldInputDescriptor<Model, NonNullable<Model[Property]>, Model[Property], Parent>} - The generated field input descriptor.
+ */
+declare function addFieldInputFromSchema<Property extends keyof FieldsModel, Model, Parent = unknown, AddModel = Model, EditModel = Model, FieldsModel = TableviewDescriptorFieldsManageMultiType<Model, AddModel, EditModel>>(descriptor: TableviewDescriptorInst<Model, any, any, Parent, any, AddModel, EditModel, FieldsModel> | EditorDescriptorInst<FieldsModel, Parent>, property: Property, propertySchema: SchemaProperty, opts?: FieldInputFromSchemaOptsType<FieldsModel>): FieldInputDescriptor<FieldsModel, NonNullable<FieldsModel[Property]>, FieldsModel[Property], Parent>;
+/**
+ * <em>Experimental:</em> Adds a field enum lookup to editor descriptor based on the given schema property and options.
+ *
+ * @experimental
+ *
+ * @param {TableviewDescriptorInst<Model, any, any, Parent> | EditorDescriptorInst<Model, Parent>} descriptor - Descriptor to add field to.
+ * @param {keyof Model} property - The property of the model.
+ * @param {SchemaEnum<Enum> | EnumDescriptor<Enum>} enumOpt - The enum schema or enum model descriptor.
+ * @param {SchemaProperty} propertySchema - The property's schema for the field.
+ *
+ * @returns {FieldLookupEnum<Enum>} - The field with enumeration values.
+ */
+declare function addFieldEnumLookupFromSchema<Model, Parent = unknown, AddModel = Model, EditModel = Model, FieldsModel = TableviewDescriptorFieldsManageMultiType<Model, AddModel, EditModel>, Enum = any>(descriptor: TableviewDescriptorInst<Model, any, any, Parent, any, AddModel, EditModel, FieldsModel> | EditorDescriptorInst<FieldsModel, Parent>, property: keyof FieldsModel, enumOpt: SchemaEnum<Enum> | EnumDescriptor<Enum>, propertySchema: SchemaProperty): FieldLookupEnumDescriptor<Enum, FieldsModel, Parent>;
+/**
+ * <em>Experimental:</em> Sets basic options for a field based on a given property schema.
+ *
+ * @param {AFieldDescriptor<FieldModel, EditorModel, FieldValue, ParentEditorModel>} field - The field to set options for.
+ * @param {SchemaProperty} propertySchema - The property schema to base the options on.
+ */
+declare function setFieldBasicOptionsFromSchema<FieldModel = any, EditorModel = any, FieldValue = FieldModel, ParentEditorModel = undefined>(field: AFieldDescriptor<FieldModel, EditorModel, FieldValue, ParentEditorModel>, propertySchema: SchemaProperty): void;
+
+/**
+ * Creates lookup data provider with predefined lookup function based on API service GetAll function.
+ *
+ * @param {ServiceClassType<Service>} service - The API service instance used to perform the `getAll` call.
+ * @param {GetAllFn} getAllFn - The function key of the `getAll` method in the service to be invoked.
+ * @param [opts] - Optional configuration for the lookup.
+ * @param [opts.search] - Search parameter definition for mapping to filter property or global search property - both cannot be used at the same time.
+ * @param {ExtractGetAllParamsFilterType<ApiServiceGetAllFilterType<Service, any, GetAllFn>>} [opts.search.filter.property] - The filter field used for search criteria.
+ * @param {FilterMatchModeType} [opts.search.filter.matchMode] - The match mode used for the filter (e.g., contains, startsWith, etc.).
+ * @param {FilterMatchModeType} [opts.search.globalSearch] - If search term is to be applied to global filter.
+ * @param {Array<DataListSort<ExtractGetAllParamsSortType<ApiServiceGetAllFilterType<Service, any, GetAllFn>>>>} [opts.sorts] - The sorting options to order the fetched data.
+ * @param {number} [opts.limit] - The number of records to fetch.
+ * @return {LookupDataProviderInst<ExtractServiceGetAllDataType<Service, GetAllFn>, Service, ExtractGetAllParamsSortType<ApiServiceGetAllFilterType<Service, any, GetAllFn>>, ExtractGetAllParamsFilterType<ApiServiceGetAllFilterType<Service, any, GetAllFn>>>} The lookup data provider instance configured with the lookup function.
+ */
+declare function lookupWithApiServiceGetAll<Service, GetAllFn extends ClassFunctionKeysWithAnyArgsAndReturnType<Service, Observable<GetAllHttpResponseType<any>>>>(service: ServiceClassType<Service>, getAllFn: GetAllFn, opts?: {
+    search?: {
+        filter?: {
+            property: ExtractGetAllParamsFilterType<ApiServiceGetAllFilterType<Service, any, GetAllFn>>;
+            matchMode?: FilterMatchModeExtendedType;
+        };
+        globalFilter?: boolean;
+    };
+    sort?: DataListSort<ExtractGetAllParamsSortType<ApiServiceGetAllFilterType<Service, any, GetAllFn>>>[];
+    limit?: number;
+}): LookupDataProviderInst<ExtractServiceGetAllDataType<Service, GetAllFn>, Service, ExtractGetAllParamsSortType<ApiServiceGetAllFilterType<Service, any, GetAllFn>>, ExtractGetAllParamsFilterType<ApiServiceGetAllFilterType<Service, any, GetAllFn>>>;
+
+type TableviewWithGetAllParamsOpts<RequestParam, TableModel, AddModel, EditModel> = {
+    requestParamsType: TypeDescriptor<RequestParam>;
+} & TableviewDescriptorInstConstructorOpts<TableModel, AddModel, EditModel>;
+/**
+ * Creates a tableview with a given model, service and sorts/filters extracted from Data API Get All request params, service, and optional build function.
+ *
+ * @param {ModelDescriptor<Model>} model - The model descriptor.
+ * @param {ServiceClassType<Service>} service - The class type of the service.
+ * @param {TypeDescriptor<RequestParam> | TableviewWithGetAllParamsOpts<RequestParam, TableModel>} paramsOrOpts - The request param of get all request. Filters and sorts will be taken from here.
+ * @param {(builder: TableviewBuilder) => void} [buildFn] - The optional callback function to customize the tableview using the prepared builder.
+ *
+ * @returns A tableview instance with descriptor, data provider and actions.
+ */
+declare function tableviewWithGetAllParams<Model, Service, RequestParam extends GetAllParamsDefaultWoFiltersType, Sorts = ExtractGetAllParamsSortType<RequestParam>, Filters extends keyof any = ExtractGetAllParamsFilterType<RequestParam>>(model: ModelDescriptor<Model>, service: ServiceClassType<Service>, params: TypeDescriptor<RequestParam>, buildFn?: (builder: TableviewInputBuilder<Model, Service, TableviewDescriptorInst<Model, Sorts, Filters, undefined, Model, Model, Model, Model>, TableviewDataProviderInst<Model, Service, Sorts, Filters>, Sorts, Filters, Model, Model, Model, Model>) => void): _mediusinc_mng_commons_tableview_api.TableviewInput<Model, Service, Sorts, Filters, Model, Model, Model, TableviewDescriptorInst<Model, Sorts, Filters, undefined, Model, Model, Model, Model>, TableviewDataProviderInst<Model, Service, Sorts, Filters, _mediusinc_mng_commons_core.ServiceClassOptType<Service>, Model, Model, Model>>;
+/**
+ * Creates a tableview with a mulit-model (separate for add, edit and details), service and sorts/filters from API service's provided getAll function.
+ *
+ * @param {ModelDescriptor<Model>} model - The model descriptor.
+ * @param {ServiceClassType<Service>} service - The class type of the service.
+ * @param {TableviewWithGetAllParamsOpts} opts - Options providing get all request parameters and models for table, add and edit.
+ * @param {(builder: TableviewBuilder) => void} [buildFn] - The optional callback function to customize the tableview using the prepared builder.
+ *
+ * @returns A tableview instance with descriptor, data provider and actions.
+ */
+declare function tableviewMultiModelWithGetAllParams<Model, Service, RequestParam extends GetAllParamsDefaultWoFiltersType, Sorts = ExtractGetAllParamsSortType<RequestParam>, Filters extends keyof any = ExtractGetAllParamsFilterType<RequestParam>, TableModel = Model, AddModel = Model, EditModel = Model, FieldsModel = TableviewDescriptorFieldsManageMultiType<Model, AddModel, EditModel>>(model: ModelDescriptor<Model>, service: ServiceClassType<Service>, opts: Required<TableviewWithGetAllParamsOpts<RequestParam, TableModel, AddModel, EditModel>>, buildFn?: (builder: TableviewInputBuilder<Model, Service, TableviewDescriptorInst<Model, Sorts, Filters, undefined, TableModel, AddModel, EditModel, FieldsModel>, TableviewDataProviderInst<Model, Service, Sorts, Filters, ServiceClassType<Service>, TableModel, AddModel, EditModel>, Sorts, Filters, TableModel, AddModel, EditModel, FieldsModel>) => void): _mediusinc_mng_commons_tableview_api.TableviewInput<Model, Service, Sorts, Filters, TableModel, AddModel, EditModel, TableviewDescriptorInst<Model, Sorts, Filters, undefined, TableModel, AddModel, EditModel, FieldsModel>, TableviewDataProviderInst<Model, Service, Sorts, Filters, ServiceClassType<Service>, TableModel, AddModel, EditModel>>;
+/**
+ * Creates a tableview with a given model, service and sorts/filters from API service's provided getAll function.
+ *
+ * @param {ModelDescriptor<Model>} model - The model descriptor.
+ * @param {ServiceClassType<Service>} service - The class type of the service.
+ * @param {GetAllFn} getAllFn - The function from service for executing getAll requests. Filters and sorts will be taken from here.
+ * @param {(builder: TableviewBuilder) => void} [buildFn] - The optional callback function to customize the tableview using the prepared builder.
+ *
+ * @returns A tableview instance with descriptor, data provider and actions.
+ */
+declare function tableviewWithApiServiceGetAll<Model, Service, GetAllFn extends ClassFunctionKeysWithAnyArgsAndReturnType<Service, Observable<GetAllHttpResponseType<TableModel>>>, TableModel = ExtractServiceGetAllDataType<Service, GetAllFn>, RequestParams extends GetAllParamsDefaultWoFiltersType = ApiServiceGetAllFilterType<Service, TableModel, GetAllFn>, Sorts = ExtractGetAllParamsSortType<RequestParams>, Filters extends keyof any = ExtractGetAllParamsFilterType<RequestParams>>(model: ModelDescriptor<Model>, service: ServiceClassType<Service>, getAllFn: GetAllFn, buildFn?: (builder: TableviewInputBuilder<Model, Service, TableviewDescriptorInst<Model, Sorts, Filters, undefined, TableModel, Model, Model, Model>, TableviewDataProviderInst<Model, Service, Sorts, Filters, ServiceClassType<Service>, TableModel>, Sorts, Filters, TableModel, Model, Model, Model>) => void): _mediusinc_mng_commons_tableview_api.TableviewInput<Model, Service, Sorts, Filters, TableModel, Model, Model, TableviewDescriptorInst<Model, Sorts, Filters, undefined, TableModel, Model, Model, Model>, TableviewDataProviderInst<Model, Service, Sorts, Filters, ServiceClassType<Service>, TableModel, Model, Model>>;
+/**
+ * Creates a tableview with a given model, service and sorts/filters from API service's provided getAll function.
+ *
+ * @param {ModelDescriptor<Model>} model - The model descriptor.
+ * @param {ServiceClassType<Service>} service - The class type of the service.
+ * @param {GetAllFn} serviceGetAllFn - The function from service for executing getAll requests. Filters and sorts will be taken from here.
+ * @param {Required<TableviewDescriptorInstConstructorOpts<TableModel, AddModel, EditModel>>} - Required options: all remaining models for multi-tableview must be defined here.
+ * @param {(builder: TableviewBuilder) => void} [buildFn] - The optional callback function to customize the tableview using the prepared builder.
+ *
+ * @returns A tableview instance with descriptor, data provider and actions.
+ */
+declare function tableviewMultiModelWithApiServiceGetAll<Model, Service, ServiceGetAllFn extends ClassFunctionKeysWithAnyArgsAndReturnType<Service, Observable<GetAllHttpResponseType<TableModel>>>, TableModel, AddModel, EditModel, ServiceGetAllRequestParams extends GetAllParamsDefaultWoFiltersType = ApiServiceGetAllFilterType<Service, TableModel, ServiceGetAllFn>, Sorts = ExtractGetAllParamsSortType<ServiceGetAllRequestParams>, Filters extends keyof any = ExtractGetAllParamsFilterType<ServiceGetAllRequestParams>, FieldsModel = TableviewDescriptorFieldsManageMultiType<Model, AddModel, EditModel>>(model: ModelDescriptor<Model>, service: ServiceClassType<Service>, serviceGetAllFn: ServiceGetAllFn, opts: Required<TableviewDescriptorInstConstructorOpts<TableModel, AddModel, EditModel>>, buildFn?: (builder: TableviewInputBuilder<Model, Service, TableviewDescriptorInst<Model, Sorts, Filters, undefined, TableModel, AddModel, EditModel, FieldsModel>, TableviewDataProviderInst<Model, Service, Sorts, Filters, ServiceClassType<Service>, TableModel, AddModel, EditModel>, Sorts, Filters, TableModel, AddModel, EditModel, FieldsModel>) => void): _mediusinc_mng_commons_tableview_api.TableviewInput<Model, Service, Sorts, Filters, TableModel, AddModel, EditModel, TableviewDescriptorInst<Model, Sorts, Filters, undefined, TableModel, AddModel, EditModel, FieldsModel>, TableviewDataProviderInst<Model, Service, Sorts, Filters, ServiceClassType<Service>, TableModel, AddModel, EditModel>>;
+
+interface FilterGenericPropertyOptsType {
+    numberOpts?: FilterNumberOptsType;
+    dateOpts?: FilterDateOptsType;
+}
+/**
+ * Maps a property type to its corresponding filter type enum and applies default
+ * filter options if no custom options are provided. If the property type is not recognized,
+ * it returns a filter type value of null.
+ *
+ * @param propertyType - The property type to convert.
+ * @param [opts] - The custom options to use for conversion.
+ */
+declare function convertPropertyTypeToFilterType(propertyType?: string, opts?: FilterGenericPropertyOptsType): {
+    filterType: FilterTypeEnum | null;
+    opts?: FilterDateOptsType | FilterNumberOptsType;
+};
+type FilterGenericPropertiesMetadataType = {
+    [key: string]: string | undefined;
+};
+/**
+ * Converts an object of properties and types into an array of filterable properties with the corresponding filter types and options.
+ * @param properties - The object containing the properties.
+ * @param [opts] - Custom filter options.
+ */
+declare function convertPropertyToFilterGenericProperties(properties: FilterGenericPropertiesMetadataType, opts?: FilterGenericPropertyOptsType): FilterGenericProperty[];
+/**
+ * Maps an Observable of properties to filter generic properties.
+ */
+declare function mapToFilterGenericProperties(opts?: FilterGenericPropertyOptsType): OperatorFunction<FilterGenericPropertiesMetadataType, FilterGenericProperty[]>;
+type FilterPropertyLookupFnType<Service> = (service: Service) => ItemOrObservable<FilterGenericPropertiesMetadataType>;
+/**
+ * Creates a data provider for generic filter properties that can be used with the TableDescriptor's generic filter functionality.
+ *
+ * @param serviceType - The service to fetch the properties from.
+ * @param lookupFn - The name of the service function to call for properties or function impl returning properties.
+ * @param [opts] - Optional custom options for filter descriptors, such as date and number formatting.
+ */
+declare function filterPropertyLookupProvider<Service>(serviceType: Type<Service>, lookupFn: FilterPropertyLookupFnType<Service> | ClassFunctionKeysWithReturnType<Service, Observable<FilterGenericPropertiesMetadataType>>, opts?: FilterGenericPropertyOptsType): LookupDataProviderInst<FilterGenericProperty, Service, keyof FilterGenericProperty, keyof FilterGenericProperty, Service extends undefined ? undefined : _mediusinc_mng_commons_core.ServiceClassType<Service>>;
+type FilterValueSuggestionLookupFnType<Service> = (service: Service, field: string, search?: string) => ItemOrObservable<string[]>;
+/**
+ * Creates a data provider for generic filter value suggestions that can be used with the TableDescriptor's generic filter functionality.
+ *
+ * @param service - The service to use for suggesting filter values.
+ * @param lookupFn - The function name of the service to call for suggestion or function impl returning suggestions.
+ */
+declare function filterValueSuggestionLookupProvider<Service>(service: Type<Service>, lookupFn: FilterValueSuggestionLookupFnType<Service> | ClassFunctionKeysWithParamAndReturnType<Service, {
+    field: string;
+    text?: string;
+}, Observable<string[]>>): LookupDataProviderInst<string, Service, string, 'field'>;
+
+export { SchemaColumnsBuilder, SchemaFieldsBuilder, addColumnFromSchema, addFieldEnumLookupFromSchema, addFieldInputFromSchema, columnsFromSchema, convertPropertyToFilterGenericProperties, convertPropertyTypeToFilterType, enumModelFromSchema, fieldsFromSchema, filterPropertyLookupProvider, filterValueSuggestionLookupProvider, lookupWithApiServiceGetAll, mapToFilterGenericProperties, setFieldBasicOptionsFromSchema, tableviewMultiModelWithApiServiceGetAll, tableviewMultiModelWithGetAllParams, tableviewWithApiServiceGetAll, tableviewWithGetAllParams };
+export type { FilterGenericPropertyOptsType };

package/version-info.json

@@ -1,11 +1,11 @@
 {
     "name": "@mediusinc/mng-commons-data-api",
-    "version": "6.2.0-rc.0",
+    "version": "7.0.0-rc.0",
     "tag": "v6.2.0-rc.0",
-    "distance": 0,
-    "hash": "3b7adfe2",
+    "distance": 6,
+    "hash": "ce245f4b",
     "dirty": true,
-    "semver": "6.2.0-rc.0+0.g3b7adfe2.dirty",
+    "semver": "6.2.0-rc.0+6.gce245f4b.dirty",
     "buildTimestamp": null,
-    "raw": "v6.2.0-rc.0-3b7adfe2-dirty"
+    "raw": "v6.2.0-rc.0-6-ce245f4b-dirty"
 }

package/lib/helpers/get-all-params.d.ts

@@ -1,93 +0,0 @@
-import { Observable } from 'rxjs';
-import { ClassFunctionKeysWithParamAndReturnType, DataListFilter, DataListParams, DataListResult } from '@mediusinc/mng-commons/core';
-import { GetAllParamsFilterMatchType, GetAllParamsType, GetAllParamsUrlQueryType, GetAllParamsUrlQueryWithFiltersInKeyType } from '../models/request-params.model';
-/**
- * Converts a filter match mode to its corresponding enum value.
- *
- * @param {string} matchMode - The filter match mode from data list filter to convert.
- * @returns {GetAllParamsFilterMatchType} - The converted enum value.
- * @throws {CommonsInternalError} - If the filter match mode is not supported.
- */
-export declare function toGetAllParamsFilterMatchMode(matchMode: string): GetAllParamsFilterMatchType;
-/**
- * Converts given parameters of a DataListParams object into a get all request param object with values as URL query string representation.
- *
- * @param {DataListParams} params - The parameters to convert.
- * @typeparam Sorts - The type of the sorting options for the data list.
- * @typeparam Filters - The type of the filters for the data list.
- * @returns {GetAllParamsUrlQueryType<Filters>} - Get all request param object with values as URL query string representation.
- */
-export declare function toGetAllParamsAsUrlQuery<Sorts, Filters extends keyof any>(params: DataListParams<Sorts, Filters>): GetAllParamsUrlQueryType<Filters>;
-/**
- * Converts given parameters of a DataListParams object into a get all request param object with values as URL query string representation.
- *
- * @param {DataListParams} params - The parameters to convert.
- * @param {FilterKey} filterKey - Property key for filter object.
- * @typeparam Sorts - The type of the sorting options for the data list.
- * @typeparam Filters - The type of the filters for the data list.
- * @typeparam FilterKey - The type representing property key where filters will be put to.
- * @returns {GetAllParamsUrlQueryWithFiltersInKeyType<FilterKey, Filters>} - Get all request param object with values as URL query string representation.
- */
-export declare function toGetAllParamsAsUrlQueryWithFiltersInProperty<Sorts, Filters extends keyof any, FilterKey extends string | number | symbol = 'filters'>(params: DataListParams<Sorts, Filters>, filterKey?: FilterKey): GetAllParamsUrlQueryWithFiltersInKeyType<FilterKey, Filters>;
-/**
- * Converts given parameters of a DataListParams object into a get all request param object with values as objects for POST requests.
- *
- * @param {DataListParams} params - The parameters to convert.
- * @typeparam Sorts - The type of the sorting options for the data list.
- * @typeparam Filters - The type of the filters for the data list.
- * @returns {GetAllParamsType<Sorts, Filters>} - Get all request param object with values as objects for POST requests.
- */
-export declare function toGetAllParams<Sorts, Filters extends keyof any>(params: DataListParams<Sorts, Filters>): GetAllParamsType<Sorts, Filters>;
-/**
- * Converts DataListParams to sort query URL representation.
- *
- * @param {DataListParams} params - The params object with sort property to convert.
- * @returns {string | undefined} - The formatted sort query URL param or undefined.
- */
-export declare function toGetAllSortAsQueryUrl(params?: DataListParams<any, any>): string | undefined;
-/**
- * Converts a DataListFilter object to a query URL string.
- *
- * @param {DataListFilter} filter - The filter object from params to convert.
- * @returns {string|undefined} - The formatted filter query URL param or undefined.
- */
-export declare function toGetAllFilterAsQueryUrl(filter?: DataListFilter): string | undefined;
-/**
- * Executes the "getAll" on API service with request parameters.
- * Get all is expected to be executed via GET method using params as URL queries.
- *
- * @param {Service} service - The API service instance.
- * @param {Function} getAllFn - The "getAll" function on provided service instance.
- * @param {Object} params - The data list params.
- * @returns {Observable<<DataListResult<Item>>>} An observable with data list result.
- */
-export declare function executeGetAll<Service, Item, Sorts, Filters extends keyof any>(service: Service, getAllFn: (requestParameters: GetAllParamsUrlQueryType<Filters>) => Observable<{
-    data?: Item[];
-    totalCount?: number;
-}>, params: DataListParams<Sorts, Filters>): Observable<DataListResult<Item>>;
-/**
- * Executes the "getAll" on API service with request parameters.
- * Get all is expected to be executed via GET method using params as URL queries.
- *
- * @param {Service} service - The API service instance.
- * @param {Function} getAllFn - The "getAll" function on provided service.
- * @param {Object} params - The data list params.
- * @returns {Observable<<DataListResult<Item>>>} An observable with data list result.
- */
-export declare function apiServiceGetAll<Service, Item, Sorts, Filters extends keyof any>(service: Service, fn: ClassFunctionKeysWithParamAndReturnType<Service, GetAllParamsUrlQueryType<Filters>, Observable<{
-    data?: Item[];
-    totalCount?: number;
-}>>, params: DataListParams<Sorts, Filters>): Observable<DataListResult<Item>>;
-/**
- * Executes the "getAll" on API service with request parameters.
- * Get all is expected to be executed via POST method using params as object in body of request.
- *
- * @param {Service} service - The API service instance.
- * @param {Function} getAllFn - The "getAll" function on provided service instance.
- * @param {Object} params - The data list params.
- * @returns {Observable<<DataListResult<Item>>>} An observable with data list result.
- */
-export declare function executeGetAllAsPost<Service, Item, Sorts, Filters extends keyof any>(service: Service, getAllFn: (requestParameters: GetAllParamsType<Sorts, Filters>) => Observable<{
-    data?: Item[];
-    totalCount?: number;
-}>, params: DataListParams<Sorts, Filters>): Observable<DataListResult<Item>>;