@mediusinc/mng-commons-data-api 5.5.0 → 6.0.0-rc.3

package/fesm2022/mediusinc-mng-commons-data-api-tableview.mjs

@@ -1,43 +1,11 @@
-import { inject, Injector } from '@angular/core';
-import { apiServiceGetAll } from '@mediusinc/mng-commons-data-api';
-import { TableviewInputBuilder, TableviewDescriptorInst, TableviewDataProviderInst, FieldInputDescriptor } from '@mediusinc/mng-commons/tableview/api';
 import { enumModelGeneric, EnumDescriptor } from '@mediusinc/mng-commons/model';
 import { CommonsInternalError, fromAngularDateFormatToPrime, toObservable, valueToDefined } from '@mediusinc/mng-commons/core';
-import { Observable } from 'rxjs';
+import { FieldInputDescriptor, TableviewDescriptorInst, TableviewInputBuilder, TableviewDataProviderInst } from '@mediusinc/mng-commons/tableview/api';
+import { map, Observable } from 'rxjs';
+import { toGetAllParamsAsUrlQuery, apiServiceGetAll } from '@mediusinc/mng-commons-data-api';
+import { LookupDataProviderInst, lookupDataProvider } from '@mediusinc/mng-commons/form/api';
+import { inject, Injector } from '@angular/core';
 import { FilterTypeEnum } from '@mediusinc/mng-commons/filter';
-import { lookupDataProviderWithService } from '@mediusinc/mng-commons/form/api';
-
-/**
- * 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>} params - 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.
- */
-function tableviewWithGetAllParams(model, service, params, buildFn) {
-    const builder = new TableviewInputBuilder(new TableviewDescriptorInst(model), new TableviewDataProviderInst(undefined, service), inject(Injector));
-    buildFn?.(builder);
-    return builder.build();
-}
-/**
- * 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.
- */
-function tableviewWithApiServiceGetAll(model, service, getAllFn, buildFn) {
-    const builder = new TableviewInputBuilder(new TableviewDescriptorInst(model), new TableviewDataProviderInst(undefined, service), inject(Injector));
-    builder.withAdjustDataProvider(dataProvider => dataProvider.withGetAll((params, service) => apiServiceGetAll(service, getAllFn, params)));
-    buildFn?.(builder);
-    return builder.build();
-}
 
 /**
  * <em>Experimental:</em> Emulates an enum model object from enum schema.
@@ -379,11 +347,12 @@ class SchemaFieldsBuilder {
      * @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) {
-        const field = this.descriptor.addFieldLookup(property);
+    addLookup(property, provider) {
+        const field = this.descriptor.addFieldLookup(property, { serviceProvider: provider });
         setFieldBasicOptionsFromSchema(field, this.schema.properties[property]);
         return field;
     }
@@ -394,117 +363,13 @@ class SchemaFieldsBuilder {
      * @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, schemaProperty) {
-        const field = this.descriptor.addFieldLookup(property);
-        setFieldBasicOptionsFromSchema(field, schemaProperty);
-        return field;
-    }
-    /**
-     * <em>Experimental:</em> Adds a lookup field.
-     * {EditorDescriptorInt.addFieldLookupWithOptionsValueProperty} 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 {TypeDescriptor<LookupModel>} type - Type of lookup model.
-     * @param {LookupValueProperty} lookupOptionsValueProperty - Value property from lookup model.
-     *
-     * @return The created lookup field.
-     */
-    addLookupWithOptionsValueProperty(property, type, lookupOptionsValueProperty) {
-        const field = this.descriptor.addFieldLookupWithOptionsValueProperty(property, type, lookupOptionsValueProperty);
-        setFieldBasicOptionsFromSchema(field, this.schema.properties[property]);
-        return field;
-    }
-    /**
-     * <em>Experimental:</em> Adds a lookup field where property schema is manually provided.
-     * {EditorDescriptorInt.addFieldLookupWithOptionsValueProperty} 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 {TypeDescriptor<LookupModel>} type - Type of lookup model.
-     * @param {LookupValueProperty} lookupOptionsValueProperty - Value property from lookup model.
-     * @param {SchemaProperty} schemaProperty - Manually provided schema property.
-     *
-     * @return The created lookup field.
-     */
-    addLookupWithOptionsValuePropertyFromSchema(property, type, lookupOptionsValueProperty, schemaProperty) {
-        const field = this.descriptor.addFieldLookupWithOptionsValueProperty(property, type, lookupOptionsValueProperty);
-        setFieldBasicOptionsFromSchema(field, schemaProperty);
-        return field;
-    }
-    /**
-     * <em>Experimental:</em> Adds a lookup field.
-     * {EditorDescriptorInt.addFieldLookupWithProvider} 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 - Lookup provider.
-     *
-     * @return The created lookup field.
-     */
-    addLookupWithProvider(property, provider) {
-        const field = this.descriptor.addFieldLookupWithProvider(property, provider);
-        setFieldBasicOptionsFromSchema(field, this.schema.properties[property]);
-        return field;
-    }
-    /**
-     * <em>Experimental:</em> Adds a lookup field where property schema is manually provided.
-     * {EditorDescriptorInt.addFieldLookupWithProvider} 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 - Lookup provider.
-     * @param {SchemaProperty} schemaProperty - Manually provided schema property.
-     *
-     * @return The created lookup field.
-     */
-    addLookupWithProviderFromSchema(property, provider, schemaProperty) {
-        const field = this.descriptor.addFieldLookupWithProvider(property, provider);
-        setFieldBasicOptionsFromSchema(field, schemaProperty);
-        return field;
-    }
-    /**
-     * <em>Experimental:</em> Adds a lookup field.
-     * {EditorDescriptorInt.addFieldLookupWithProviderAndOptionsValueProperty} 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 - Lookup provider.
-     * @param {TypeDescriptor<LookupModel>} type - Type of lookup model.
-     * @param {LookupValueProperty} lookupOptionsValueProperty - Value property from lookup model.
-     *
-     * @return The created lookup field.
-     */
-    addLookupWithProviderAndOptionsValueProperty(property, provider, type, lookupOptionsValueProperty) {
-        const field = this.descriptor.addFieldLookupWithProviderAndOptionsValueProperty(property, provider, type, lookupOptionsValueProperty);
-        setFieldBasicOptionsFromSchema(field, this.schema.properties[property]);
-        return field;
-    }
-    /**
-     * <em>Experimental:</em> Adds a lookup field where property schema is manually provided.
-     * {EditorDescriptorInt.addFieldLookupWithProviderAndOptionsValueProperty} 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 - Lookup provider.
-     * @param {TypeDescriptor<LookupModel>} type - Type of lookup model.
-     * @param {LookupValueProperty} lookupOptionsValueProperty - Value property from lookup model.
-     * @param {SchemaProperty} schemaProperty - Manually provided schema property.
-     *
-     * @return The created lookup field.
-     */
-    addLookupWithProviderAndOptionsValuePropertyFromSchema(property, provider, type, lookupOptionsValueProperty, schemaProperty) {
-        const field = this.descriptor.addFieldLookupWithProviderAndOptionsValueProperty(property, provider, type, lookupOptionsValueProperty);
+    addLookupFromSchema(property, provider, schemaProperty) {
+        const field = this.descriptor.addFieldLookup(property, { serviceProvider: provider });
         setFieldBasicOptionsFromSchema(field, schemaProperty);
         return field;
     }
@@ -515,7 +380,7 @@ class SchemaFieldsBuilder {
      * @experimental
      *
      * @param {Property} property - The property to create the many editor field for.
-     * @param {TableviewDescriptorInst<FieldModel, any, any, Model>} tableviewDescriptor - Tableview descriptor.
+     * @param {TableviewDescriptorInst<FieldModel, any, any, FieldsModel>} tableviewDescriptor - Tableview descriptor.
      *
      * @return The created one-to-many editor field.
      */
@@ -531,7 +396,7 @@ class SchemaFieldsBuilder {
      * @experimental
      *
      * @param {Property} property - The property to create the many editor field for.
-     * @param {TableviewDescriptorInst<FieldModel, any, any, Model>} tableviewDescriptor - Tableview descriptor.
+     * @param {TableviewDescriptorType<FieldModel, any, any, FieldsModel>} tableviewDescriptor - Tableview descriptor.
      * @param {SchemaProperty} schemaProperty - Manually provided schema property.
      *
      * @return The created one-to-many editor field.
@@ -584,11 +449,11 @@ class SchemaFieldsBuilder {
  *
  * @experimental
  *
- * @param {TableviewDescriptorInst<Model, any, any, Parent> | EditorDescriptorInst<Model, Parent>} descriptor - Descriptor to add fields to.
+ * @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, SchModel>} - The SchemaFieldsBuilder object containing the extracted fields.
+ * @return {SchemaFieldsBuilder<Model, Parent, AddModel, EditModel , FieldsModel, SchModel>} - The SchemaFieldsBuilder object containing the extracted fields.
  */
 function fieldsFromSchema(descriptor, schema, opts) {
     return new SchemaFieldsBuilder(descriptor, schema, opts);
@@ -609,9 +474,7 @@ function addFieldInputFromSchema(descriptor, property, propertySchema, opts) {
     const propertyType = opts?.fieldType ?? propertySchema.type;
     const field = new FieldInputDescriptor(property);
     if (descriptor instanceof TableviewDescriptorInst) {
-        descriptor.detailsEditor.addFieldDescriptor(field);
-        descriptor.editEditor.addFieldDescriptor(field);
-        descriptor.addEditor.addFieldDescriptor(field);
+        descriptor.addFieldDescriptor(field);
     }
     else {
         descriptor.addFieldDescriptor(field);
@@ -722,6 +585,127 @@ function setFieldBasicOptionsFromSchema(field, propertySchema) {
         field.withDisabled();
 }
 
+/**
+ * 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.
+ */
+function lookupWithApiServiceGetAll(service, getAllFn, opts) {
+    return new LookupDataProviderInst(service).withLookup((params, service, search) => {
+        if (search != null && search.length > 0) {
+            if (opts?.search?.filter) {
+                params = {
+                    offset: params?.offset,
+                    limit: params?.limit,
+                    sort: params?.sort,
+                    filters: {
+                        ...{
+                            [opts.search.filter.property]: {
+                                value: search,
+                                matchMode: opts.search.filter.matchMode ?? 'equals'
+                            }
+                        }
+                    }
+                };
+            }
+            else if (opts?.search?.globalFilter) {
+                params = {
+                    offset: params?.offset,
+                    limit: params?.limit,
+                    sort: params?.sort,
+                    search: search
+                };
+            }
+        }
+        if (opts?.sort && opts.sort.length > 0) {
+            params = {
+                ...params,
+                sort: opts?.sort
+            };
+        }
+        if (opts?.limit != null) {
+            params = {
+                ...params,
+                limit: opts?.limit
+            };
+        }
+        return service[getAllFn](toGetAllParamsAsUrlQuery(params ?? {})).pipe(map(res => res.data ?? []));
+    });
+}
+
+/**
+ * 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.
+ */
+function tableviewWithGetAllParams(model, service, params, buildFn) {
+    const builder = new TableviewInputBuilder(new TableviewDescriptorInst(model), new TableviewDataProviderInst(service), inject(Injector));
+    buildFn?.(builder);
+    return builder.build();
+}
+/**
+ * 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.
+ */
+function tableviewMultiModelWithGetAllParams(model, service, opts, buildFn) {
+    const builder = new TableviewInputBuilder(new TableviewDescriptorInst(model, opts), new TableviewDataProviderInst(service), inject(Injector));
+    buildFn?.(builder);
+    return builder.build();
+}
+/**
+ * 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.
+ */
+function tableviewWithApiServiceGetAll(model, service, getAllFn, buildFn) {
+    const builder = new TableviewInputBuilder(new TableviewDescriptorInst(model), new TableviewDataProviderInst(service), inject(Injector));
+    builder.withAdjustDataProvider(dataProvider => dataProvider.withGetAll((params, service) => apiServiceGetAll(service, getAllFn, params)));
+    buildFn?.(builder);
+    return builder.build();
+}
+/**
+ * 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.
+ */
+function tableviewMultiModelWithApiServiceGetAll(model, service, serviceGetAllFn, opts, buildFn) {
+    const builder = new TableviewInputBuilder(new TableviewDescriptorInst(model, opts), new TableviewDataProviderInst(service), inject(Injector));
+    builder.withAdjustDataProvider(dataProvider => dataProvider.withGetAll((params, service) => apiServiceGetAll(service, serviceGetAllFn, params)));
+    buildFn?.(builder);
+    return builder.build();
+}
+
 /**
  * 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,
@@ -821,10 +805,10 @@ function mapToFilterGenericProperties(opts) {
  */
 function filterPropertyLookupProvider(serviceType, lookupFn, opts) {
     if (typeof lookupFn === 'function') {
-        return lookupDataProviderWithService(serviceType).withLookup((_, service) => toObservable(lookupFn(service)).pipe(mapToFilterGenericProperties(opts)));
+        return lookupDataProvider({ service: serviceType }).withLookup((_, service) => toObservable(lookupFn(service)).pipe(mapToFilterGenericProperties(opts)));
     }
     else {
-        return lookupDataProviderWithService(serviceType).withLookup((_, service) => service[lookupFn]().pipe(mapToFilterGenericProperties(opts)));
+        return lookupDataProvider({ service: serviceType }).withLookup((_, service) => service[lookupFn]().pipe(mapToFilterGenericProperties(opts)));
     }
 }
 /**
@@ -835,19 +819,21 @@ function filterPropertyLookupProvider(serviceType, lookupFn, opts) {
  */
 function filterValueSuggestionLookupProvider(service, lookupFn) {
     if (typeof lookupFn === 'function') {
-        return lookupDataProviderWithService(service).withLookup((params, service, search) => lookupFn(service, valueToDefined(params?.filters?.['field']?.value), search));
+        return lookupDataProvider({ service }).withLookup((params, service, search) => lookupFn(service, valueToDefined(params?.filters?.['field']?.value), search));
     }
     else {
-        return lookupDataProviderWithService(service).withLookup((params, service, search) => service[lookupFn]({
+        return lookupDataProvider({ service }).withLookup((params, service, search) => service[lookupFn]({
             field: valueToDefined(params?.filters?.['field']?.value).toString(),
             text: search
         }));
     }
 }
 
+// schema
+
 /**
  * Generated bundle index. Do not edit.
  */
 
-export { SchemaColumnsBuilder, SchemaFieldsBuilder, addColumnFromSchema, addFieldEnumLookupFromSchema, addFieldInputFromSchema, columnsFromSchema, convertPropertyToFilterGenericProperties, convertPropertyTypeToFilterType, enumModelFromSchema, fieldsFromSchema, filterPropertyLookupProvider, filterValueSuggestionLookupProvider, mapToFilterGenericProperties, setFieldBasicOptionsFromSchema, tableviewWithApiServiceGetAll, tableviewWithGetAllParams };
+export { SchemaColumnsBuilder, SchemaFieldsBuilder, addColumnFromSchema, addFieldEnumLookupFromSchema, addFieldInputFromSchema, columnsFromSchema, convertPropertyToFilterGenericProperties, convertPropertyTypeToFilterType, enumModelFromSchema, fieldsFromSchema, filterPropertyLookupProvider, filterValueSuggestionLookupProvider, lookupWithApiServiceGetAll, mapToFilterGenericProperties, setFieldBasicOptionsFromSchema, tableviewMultiModelWithApiServiceGetAll, tableviewMultiModelWithGetAllParams, tableviewWithApiServiceGetAll, tableviewWithGetAllParams };
 //# sourceMappingURL=mediusinc-mng-commons-data-api-tableview.mjs.map