refactor: reference data nested fields now accessible #87700 (#2476)

Author: AntoineRelief

libs/shared/src/lib/components/ui/aggregation-builder/aggregation-builder.component.ts

@@ -19,6 +19,7 @@ import {
 } from '../../../models/aggregation.model';
 import { getReferenceMetadata } from '../../../utils/reference-data-metadata.util';
 import { PipelineStage } from './pipeline/pipeline-stage.enum';
+import { getReferenceDataAggregationFields } from '../../../utils/reference-data/aggregation-fields.util';
 
 /**
  * Main component of Aggregation builder.
@@ -220,17 +221,10 @@ export class AggregationBuilderComponent
         );
       this.fields.next(fields);
     } else if (this.referenceData) {
-      const fields = this.queryBuilder
-        .getFields(this.referenceData.graphQLTypeName as string)
-        .filter(
-          (field: any) =>
-            !(
-              field.name.includes('_id') &&
-              (field.type.name === 'ID' ||
-                (field.type?.kind === 'LIST' &&
-                  field.type.ofType.name === 'ID'))
-            )
-        );
+      const fields = getReferenceDataAggregationFields(
+        this.referenceData,
+        this.queryBuilder
+      );
       this.fields.next(fields);
     }
   }

libs/shared/src/lib/components/widgets/map-settings/edit-layer-modal/edit-layer-modal.component.ts

@@ -544,7 +544,7 @@ export class EditLayerModalComponent
               );
               this.fields.next(
                 this.aggregation
-                  ? this.mapLayersService.getAggregationFields(
+                  ? this.mapLayersService.getResourceAggregationFields(
                       data.resource.queryName ?? '',
                       this.aggregation
                     )
@@ -583,8 +583,8 @@ export class EditLayerModalComponent
             );
             this.fields.next(
               this.aggregation
-                ? this.mapLayersService.getAggregationFields(
-                    data.referenceData.graphQLTypeName ?? '',
+                ? this.mapLayersService.getReferenceDataAggregationFields(
+                    data.referenceData,
                     this.aggregation
                   )
                 : []

libs/shared/src/lib/services/aggregation-builder/aggregation-builder.service.ts

@@ -8,6 +8,7 @@ import { QueryBuilderService } from '../query-builder/query-builder.service';
 import { Aggregation } from '../../models/aggregation.model';
 import { Resource } from '../../models/resource.model';
 import { ReferenceData } from '../../models/reference-data.model';
+import getReferenceDataAggregationFields from '../../utils/reference-data/aggregation-fields.util';
 
 /**
  * Shared aggregation service.
@@ -225,19 +226,25 @@ export class AggregationBuilderService {
       referenceData?: ReferenceData | null;
     }
   ) {
-    const queryName = options.resource
-      ? options.resource.queryName
-      : options.referenceData?.graphQLTypeName;
-    const fields = this.queryBuilder
-      .getFields(queryName as string)
-      .filter(
-        (field: any) =>
-          !(
-            field.name.includes('_id') &&
-            (field.type.name === 'ID' ||
-              (field.type.kind === 'LIST' && field.type.ofType.name === 'ID'))
-          )
+    let fields: any[] = [];
+    if (options.referenceData) {
+      fields = getReferenceDataAggregationFields(
+        options.referenceData,
+        this.queryBuilder
       );
+    } else {
+      fields = this.queryBuilder
+        .getFields(options.resource?.queryName as string)
+        .filter(
+          (field: any) =>
+            !(
+              field.name.includes('_id') &&
+              (field.type.name === 'ID' ||
+                (field.type.kind === 'LIST' && field.type.ofType.name === 'ID'))
+            )
+        );
+    }
+
     const selectedFields = aggregation.sourceFields
       .map((x: string) => {
         const field = fields.find((y) => x === y.name);

libs/shared/src/lib/services/map/map-layers.service.ts

@@ -35,6 +35,8 @@ import { ContextService } from '../context/context.service';
 import { DOCUMENT } from '@angular/common';
 import { MapPolygonsService } from './map-polygons.service';
 import { WidgetService } from '../widget/widget.service';
+import { ReferenceData } from '../../models/reference-data.model';
+import getReferenceDataAggregationFields from '../../utils/reference-data/aggregation-fields.util';
 
 /**
  * Shared map layer service
@@ -212,14 +214,57 @@ export class MapLayersService {
     return get(layout, 'query.fields', []);
   }
 
+  /**
+   * Get reference data aggregation fields
+   *
+   * @param referenceData Reference data
+   * @param aggregation Current aggregation
+   * @returns list of aggregation fields
+   */
+  public getReferenceDataAggregationFields(
+    referenceData: ReferenceData,
+    aggregation: Aggregation | null
+  ) {
+    const fields = getReferenceDataAggregationFields(
+      referenceData,
+      this.queryBuilder
+    );
+    const selectedFields = aggregation?.sourceFields
+      .map((x: string) => {
+        const field = fields.find((y) => x === y.name);
+        if (!field) return null;
+        if (field.type.kind !== 'SCALAR') {
+          Object.assign(field, {
+            fields: this.queryBuilder
+              .getFieldsFromType(
+                field.type.kind === 'OBJECT'
+                  ? field.type.name
+                  : field.type.ofType.name
+              )
+              .filter((y) => y.type.name !== 'ID' && y.type.kind === 'SCALAR'),
+          });
+        }
+        return field;
+      })
+      // @TODO To be improved - Get only the JSON type fields for this case
+      .filter((x: any) => x !== null);
+    return this.aggregationBuilder
+      .fieldsAfter(selectedFields, aggregation?.pipeline)
+      .map((field) => ({
+        name: field.name,
+        label: field.name,
+        type: field.type.name,
+      }));
+  }
+
   /**
    * Get fields from aggregation
    *
    * @param queryName query name to get the fields
-   * @param aggregation A aggregation
-   * @returns aggregation fields
+   * @param aggregation Current aggregation
+   * @returns list of aggregation fields
    */
-  public getAggregationFields(
+  public getResourceAggregationFields(
     queryName: string,
     aggregation: Aggregation | null
   ) {

libs/shared/src/lib/utils/reference-data/aggregation-fields.util.ts

@@ -0,0 +1,38 @@
+import { ReferenceData } from '../../models/reference-data.model';
+import { QueryBuilderService } from '../../services/query-builder/query-builder.service';
+
+/**
+ * Get list of aggregation fields from reference data
+ *
+ * @param referenceData Reference data
+ * @param queryBuilder query builder service instance
+ * @returns list of fields
+ */
+export const getReferenceDataAggregationFields = (
+  referenceData: ReferenceData,
+  queryBuilder: QueryBuilderService
+) => {
+  const fields = queryBuilder
+    .getFields(referenceData.graphQLTypeName as string)
+    .filter(
+      (field: any) =>
+        !(
+          field.name.includes('_id') &&
+          (field.type.name === 'ID' ||
+            (field.type?.kind === 'LIST' && field.type.ofType.name === 'ID'))
+        )
+    );
+  for (const field of referenceData.fields || []) {
+    if (!fields.find((f) => f.name === field.name)) {
+      // todo: there should be a switch using field type
+      fields.push({
+        name: field.name,
+        type: { kind: 'SCALAR', name: 'String', fields: [] },
+        args: [],
+      });
+    }
+  }
+  return fields;
+};
+
+export default getReferenceDataAggregationFields;