geonetwork-ui 2.4.0-dev.e1bb65c4 → 2.4.0-dev.e6ae55aa

package/src/libs/feature/editor/src/lib/components/record-form/form-field/form-field.component.ts

@@ -25,10 +25,10 @@ import { FormFieldObjectComponent } from './form-field-object/form-field-object.
 import { FormFieldRichComponent } from './form-field-rich/form-field-rich.component'
 import { FormFieldSimpleComponent } from './form-field-simple/form-field-simple.component'
 import { FormFieldSpatialExtentComponent } from './form-field-spatial-extent/form-field-spatial-extent.component'
-import { FormFieldConfig } from './form-field.model'
 import { FormFieldUpdateFrequencyComponent } from './form-field-update-frequency/form-field-update-frequency.component'
 import { CatalogRecordKeys } from '../../../../../../../../libs/common/domain/src/lib/model/record'
 import { FormFieldKeywordsComponent } from './form-field-keywords/form-field-keywords.component'
+import { FormFieldConfig } from '../../../models'
 
 @Component({
   selector: 'gn-ui-form-field',
@@ -65,6 +65,7 @@ export class FormFieldComponent {
       emitEvent: false,
     })
   }
+
   @Output() valueChange: Observable<unknown>
 
   @ViewChild('titleInput') titleInput: ElementRef

package/src/libs/feature/editor/src/lib/components/record-form/form-field/index.ts

@@ -9,4 +9,3 @@ export * from './form-field-object/form-field-object.component'
 export * from './form-field-array/form-field-array.component'
 export * from './form-field-spatial-extent/form-field-spatial-extent.component'
 export * from './form-field.component'
-export * from './form-field.model'

package/src/libs/feature/editor/src/lib/components/record-form/record-form.component.html

@@ -1,11 +1,51 @@
-<div class="flex flex-col gap-6 p-6">
-  <ng-container *ngFor="let field of fields$ | async; trackBy: fieldTracker">
-    <gn-ui-form-field
-      *ngIf="field.config.formFieldConfig && !field.config.hidden"
-      [model]="field.config.model"
-      [config]="field.config.formFieldConfig"
-      [value]="field.value"
-      (valueChange)="handleFieldValueChange(field, $event)"
-    ></gn-ui-form-field>
-  </ng-container>
-</div>
+<ng-container>
+  <div class="flex flex-col gap-6 p-8">
+    <ng-container
+      *ngFor="
+        let section of facade.currentSections$ | async;
+        trackBy: sectionTracker
+      "
+    >
+      <ng-container *ngIf="!section.hidden">
+        <div class="flex flex-col gap-8 border p-8 rounded-[8px] shadow">
+          <div
+            class="flex flex-col gap-2"
+            [ngClass]="section.labelKey ? 'mb-4' : 'hidden'"
+          >
+            <div
+              *ngIf="section.labelKey"
+              class="text-2xl font-petrona text-secondary"
+              translate
+            >
+              {{ section.labelKey }}
+            </div>
+            <div
+              *ngIf="section.descriptionKey"
+              class="text-secondary-lightest"
+              translate
+            >
+              {{ section.descriptionKey }}
+            </div>
+          </div>
+          <ng-container
+            *ngFor="
+              let field of section.fieldsWithValues;
+              trackBy: fieldTracker
+            "
+          >
+            <ng-container *ngIf="!field.config.hidden">
+              <gn-ui-form-field
+                [model]="field.config.model!"
+                [config]="field.config.formFieldConfig"
+                [value]="field.value"
+                (valueChange)="
+                  handleFieldValueChange(field.config.model!, $event)
+                "
+              ></gn-ui-form-field>
+            </ng-container>
+          </ng-container>
+        </div>
+      </ng-container>
+    </ng-container>
+  </div>
+</ng-container>

package/src/libs/feature/editor/src/lib/components/record-form/record-form.component.ts

@@ -1,8 +1,13 @@
 import { CommonModule } from '@angular/common'
 import { ChangeDetectionStrategy, Component } from '@angular/core'
 import { EditorFacade } from '../../+state/editor.facade'
-import { EditorFieldState, EditorFieldValue } from '../../models/fields.model'
+import { EditorFieldValue } from '../../models'
 import { FormFieldComponent } from './form-field'
+import { TranslateModule } from '@ngx-translate/core'
+import {
+  EditorFieldWithValue,
+  EditorSectionWithValues,
+} from '../../+state/editor.models'
 
 @Component({
   selector: 'gn-ui-record-form',
@@ -10,21 +15,23 @@ import { FormFieldComponent } from './form-field'
   styleUrls: ['./record-form.component.css'],
   changeDetection: ChangeDetectionStrategy.OnPush,
   standalone: true,
-  imports: [CommonModule, FormFieldComponent],
+  imports: [CommonModule, FormFieldComponent, TranslateModule],
 })
 export class RecordFormComponent {
-  fields$ = this.facade.recordFields$
-
   constructor(public facade: EditorFacade) {}
 
-  handleFieldValueChange(field: EditorFieldState, newValue: EditorFieldValue) {
-    if (!field.config.model) {
+  handleFieldValueChange(model: string, newValue: EditorFieldValue) {
+    if (!model) {
       return
     }
-    this.facade.updateRecordField(field.config.model, newValue)
+    this.facade.updateRecordField(model, newValue)
   }
 
-  fieldTracker(index: number, field: EditorFieldState) {
+  fieldTracker(index: number, field: EditorFieldWithValue): any {
     return field.config.model
   }
+
+  sectionTracker(index: number, section: EditorSectionWithValues): any {
+    return section.labelKey
+  }
 }

package/src/libs/feature/editor/src/lib/expressions.ts

@@ -1,4 +1,4 @@
-import { EditorFieldState, EditorFieldValue } from './models/fields.model'
+import { EditorFieldState, EditorFieldValue } from './models/'
 
 export type ExpressionEvaluator = (field: EditorFieldState) => EditorFieldValue
 

package/src/libs/feature/editor/src/lib/fields.config.ts

@@ -1,71 +1,185 @@
 import { marker } from '@biesbjerg/ngx-translate-extract-marker'
-import { EditorFieldsConfig } from './models/fields.model'
-
-export const DEFAULT_FIELDS: EditorFieldsConfig = [
-  {
-    model: 'title',
-    formFieldConfig: {
-      labelKey: 'Metadata title',
-      type: 'text',
-    },
+import {
+  EditorConfig,
+  EditorField,
+  EditorSection,
+} from './models/editor-config.model'
+
+/**
+ * This file contains the configuration of the fields that will be displayed in the editor.
+ * To add a new field, you need to create a new EditorField object in the fields part of this file.
+ * Then add it to the corresponding section in the sections part of this file.
+ * Finally, add the section to the corresponding page in the pages part of this file.
+ */
+
+/************************************************************
+ ***************           FIELDS           *****************
+ ************************************************************
+ */
+
+export const RECORD_LICENSE_FIELD: EditorField = {
+  model: 'licenses',
+  formFieldConfig: {
+    labelKey: marker('editor.record.form.field.license'),
   },
-  {
-    model: 'abstract',
-    formFieldConfig: {
-      labelKey: 'Abstract',
-      type: 'rich',
-    },
+}
+
+export const RECORD_KEYWORDS_FIELD: EditorField = {
+  model: 'keywords',
+  formFieldConfig: {
+    labelKey: marker('editor.record.form.field.keywords'),
   },
-  {
-    model: 'uniqueIdentifier',
-    formFieldConfig: {
-      labelKey: 'Unique identifier',
-      type: 'text',
-      locked: true,
-    },
+}
+
+export const RECORD_UNIQUE_IDENTIFIER_FIELD: EditorField = {
+  model: 'uniqueIdentifier',
+  formFieldConfig: {
+    labelKey: marker('editor.record.form.field.uniqueIdentifier'),
+    locked: true,
   },
-  {
-    model: 'recordUpdated',
-    formFieldConfig: {
-      labelKey: 'Record Updated',
-      type: 'text',
-      locked: true,
-    },
-    onSaveProcess: '${dateNow()}',
+}
+
+export const RECORD_RESOURCE_UPDATED_FIELD: EditorField = {
+  model: 'resourceUpdated',
+  formFieldConfig: {
+    labelKey: marker('editor.record.form.field.resourceUpdated'),
   },
-  {
-    model: 'licenses',
-    formFieldConfig: {
-      labelKey: marker('editor.record.form.license'),
-      type: 'list',
-    },
+}
+
+export const RECORD_UPDATED_FIELD: EditorField = {
+  model: 'recordUpdated',
+  formFieldConfig: {
+    labelKey: marker('editor.record.form.field.recordUpdated'),
+    locked: true,
   },
-  {
-    model: 'resourceUpdated',
-    formFieldConfig: {
-      labelKey: marker('editor.record.form.resourceUpdated'),
-      type: 'date',
-    },
+  onSaveProcess: '${dateNow()}',
+}
+
+export const RECORD_UPDATE_FREQUENCY_FIELD: EditorField = {
+  model: 'updateFrequency',
+  formFieldConfig: {
+    labelKey: marker('editor.record.form.field.updateFrequency'),
   },
-  {
-    model: 'updateFrequency',
-    formFieldConfig: {
-      labelKey: marker('editor.record.form.updateFrequency'),
-      type: 'text',
-    },
+}
+
+export const RECORD_TEMPORAL_EXTENTS_FIELD: EditorField = {
+  model: 'temporalExtents',
+  formFieldConfig: {
+    labelKey: marker('editor.record.form.field.temporalExtents'),
   },
-  {
-    model: 'temporalExtents',
-    formFieldConfig: {
-      labelKey: marker('editor.record.form.temporalExtents'),
-      type: 'list',
-    },
+}
+
+export const RECORD_TITLE_FIELD: EditorField = {
+  model: 'title',
+  formFieldConfig: {
+    labelKey: marker('editor.record.form.field.title'),
   },
-  {
-    model: 'keywords',
-    formFieldConfig: {
-      labelKey: marker('editor.record.form.keywords'),
-      type: 'list',
-    },
+}
+
+export const RECORD_ABSTRACT_FIELD: EditorField = {
+  model: 'abstract',
+  formFieldConfig: {
+    labelKey: marker('editor.record.form.field.abstract'),
   },
-]
+}
+
+/************************************************************
+ ***************          SECTIONS          *****************
+ ************************************************************
+ */
+
+export const TITLE_SECTION: EditorSection = {
+  hidden: false,
+  fields: [RECORD_TITLE_FIELD, RECORD_ABSTRACT_FIELD],
+}
+
+export const ABOUT_SECTION: EditorSection = {
+  labelKey: marker('editor.record.form.section.about.label'),
+  descriptionKey: marker('editor.record.form.section.about.description'),
+  hidden: false,
+  fields: [
+    RECORD_UNIQUE_IDENTIFIER_FIELD,
+    RECORD_RESOURCE_UPDATED_FIELD,
+    RECORD_UPDATED_FIELD,
+    RECORD_UPDATE_FREQUENCY_FIELD,
+    RECORD_TEMPORAL_EXTENTS_FIELD,
+  ],
+}
+
+export const GEOGRAPHICAL_COVERAGE_SECTION: EditorSection = {
+  labelKey: marker('editor.record.form.section.geographicalCoverage.label'),
+  hidden: false,
+  fields: [],
+}
+
+export const ASSOCIATED_RESOURCES_SECTION: EditorSection = {
+  labelKey: marker('editor.record.form.section.associatedResources.label'),
+  descriptionKey: marker(
+    'editor.record.form.section.associatedResources.description'
+  ),
+  hidden: false,
+  fields: [],
+}
+
+export const ANNEXES_SECTION: EditorSection = {
+  labelKey: marker('editor.record.form.section.annexes.label'),
+  hidden: false,
+  fields: [],
+}
+
+export const CLASSIFICATION_SECTION: EditorSection = {
+  labelKey: marker('editor.record.form.section.classification.label'),
+  descriptionKey: marker(
+    'editor.record.form.section.classification.description'
+  ),
+  hidden: false,
+  fields: [RECORD_KEYWORDS_FIELD],
+}
+
+export const USE_AND_ACCESS_CONDITIONS_SECTION: EditorSection = {
+  labelKey: marker('editor.record.form.section.useAndAccessConditions.label'),
+  hidden: false,
+  fields: [RECORD_LICENSE_FIELD],
+}
+
+export const DATA_MANAGERS_SECTION: EditorSection = {
+  labelKey: marker('editor.record.form.section.dataManagers.label'),
+  descriptionKey: marker('editor.record.form.section.dataManagers.description'),
+  hidden: false,
+  fields: [],
+}
+
+export const DATA_POINT_OF_CONTACT_SECTION: EditorSection = {
+  labelKey: marker('editor.record.form.section.dataPointOfContact.label'),
+  descriptionKey: marker(
+    'editor.record.form.section.dataPointOfContact.description'
+  ),
+  hidden: false,
+  fields: [],
+}
+
+/************************************************************
+ ***************           PAGES            *****************
+ ************************************************************
+ */
+export const DEFAULT_CONFIGURATION: EditorConfig = {
+  pages: [
+    {
+      labelKey: marker('editor.record.form.page.description'),
+      sections: [TITLE_SECTION, ABOUT_SECTION, GEOGRAPHICAL_COVERAGE_SECTION],
+    },
+    {
+      labelKey: marker('editor.record.form.page.ressources'),
+      sections: [ASSOCIATED_RESOURCES_SECTION, ANNEXES_SECTION],
+    },
+    {
+      labelKey: marker('editor.record.form.page.accessAndContact'),
+      sections: [
+        CLASSIFICATION_SECTION,
+        USE_AND_ACCESS_CONDITIONS_SECTION,
+        DATA_MANAGERS_SECTION,
+        DATA_POINT_OF_CONTACT_SECTION,
+      ],
+    },
+  ],
+}

package/src/libs/feature/editor/src/lib/models/editor-config.model.ts

@@ -0,0 +1,53 @@
+import { CatalogRecordKeys } from '../../../../../../libs/common/domain/src/lib/model/record'
+
+// Expressions should be enclosed in `${}` to be recognized as such
+// eg. ${dateNow()}
+export type EditorFieldExpression = `$\{${string}}`
+
+export type EditorFieldValue = string | number | boolean | unknown
+
+export interface FormFieldConfig {
+  labelKey?: string
+  hintKey?: string
+  tooltipKey?: string
+  required?: boolean
+  locked?: boolean
+  invalid?: boolean
+  invalidHintKey?: string
+}
+
+export interface EditorField {
+  // configuration of the form field used as presentation
+  formFieldConfig: FormFieldConfig
+
+  // name of the target field in the record; will not change the record directly if not defined
+  model?: CatalogRecordKeys
+
+  // a hidden field won't show but can still be used to modify the record
+  // FIXME: currently this is redundant with an absence of formFieldConfig but necessary for clarity
+  hidden?: boolean
+
+  // the result of this expression will replace the field value on save
+  onSaveProcess?: EditorFieldExpression
+}
+
+export interface EditorSection {
+  labelKey?: string
+  descriptionKey?: string
+  hidden: boolean
+  fields: EditorField[]
+}
+
+export interface EditorFieldPage {
+  labelKey?: string
+  sections: EditorSection[]
+}
+
+export interface EditorConfig {
+  pages: EditorFieldPage[]
+}
+
+export interface EditorFieldState {
+  model: string
+  value: EditorFieldValue
+}

package/src/libs/feature/editor/src/lib/models/index.ts

@@ -1,2 +1,3 @@
 export * from './wizard-field.model'
 export * from './wizard-field.type'
+export * from './editor-config.model'

package/src/libs/feature/editor/src/lib/services/editor.service.ts

@@ -2,7 +2,7 @@ import { Injectable } from '@angular/core'
 import { Observable, switchMap } from 'rxjs'
 import { map, tap } from 'rxjs/operators'
 import { CatalogRecord } from '../../../../../../libs/common/domain/src/lib/model/record'
-import { EditorFieldsConfig } from '../models/fields.model'
+import { EditorConfig } from '../models/'
 import { evaluate } from '../expressions'
 import { RecordsRepositoryInterface } from '../../../../../../libs/common/domain/src/lib/repository/records-repository.interface'
 
@@ -15,17 +15,21 @@ export class EditorService {
   // returns the record as it was when saved, alongside its source
   saveRecord(
     record: CatalogRecord,
-    fieldsConfig: EditorFieldsConfig,
+    fieldsConfig: EditorConfig,
     generateNewUniqueIdentifier = false
   ): Observable<[CatalogRecord, string]> {
     const savedRecord = { ...record }
 
+    const fields = fieldsConfig.pages.flatMap((page) =>
+      page.sections.flatMap((section) => section.fields)
+    )
+
     // run onSave processes
-    for (const field of fieldsConfig) {
+    for (const field of fields) {
       if (field.onSaveProcess && field.model) {
         const evaluator = evaluate(field.onSaveProcess)
         savedRecord[field.model] = evaluator({
-          config: field,
+          model: field.model,
           value: record[field.model],
         })
       }

package/src/libs/feature/record/src/lib/data-view-permalink/data-view-permalink.component.ts

@@ -3,10 +3,11 @@ import {
   Component,
   Inject,
   InjectionToken,
+  Input,
   Optional,
 } from '@angular/core'
 import { Configuration } from '../../../../../../libs/data-access/gn4/src'
-import { combineLatest, map } from 'rxjs'
+import { BehaviorSubject, combineLatest, map } from 'rxjs'
 import { MdViewFacade } from '../state'
 import { GN_UI_VERSION } from '../gn-ui-version.token'
 
@@ -21,29 +22,45 @@ export const WEB_COMPONENT_EMBEDDER_URL = new InjectionToken<string>(
   changeDetection: ChangeDetectionStrategy.OnPush,
 })
 export class DataViewPermalinkComponent {
+  viewType$ = new BehaviorSubject<string>('map')
+  @Input()
+  set viewType(value: string) {
+    this.viewType$.next(value)
+  }
+
   permalinkUrl$ = combineLatest([
+    this.viewType$,
     this.facade.chartConfig$,
     this.facade.metadata$,
   ]).pipe(
-    map(([config, metadata]) => {
-      if (config) {
-        const { aggregation, xProperty, yProperty, chartType } = config
-        const url = new URL(`${this.wcEmbedderBaseUrl}`, window.location.origin)
-        url.searchParams.set('v', `${this.version}`)
-        url.searchParams.append('e', `gn-dataset-view-chart`)
-        url.searchParams.append('a', `api-url=${this.config.basePath}`)
-        url.searchParams.append('a', `dataset-id=${metadata.uniqueIdentifier}`)
-        url.searchParams.append('a', `primary-color=#0f4395`)
-        url.searchParams.append('a', `secondary-color=#8bc832`)
-        url.searchParams.append('a', `main-color=#555`)
-        url.searchParams.append('a', `background-color=#fdfbff`)
-        url.searchParams.append('a', `aggregation=${aggregation}`)
-        url.searchParams.append('a', `x-property=${xProperty}`)
-        url.searchParams.append('a', `y-property=${yProperty}`)
-        url.searchParams.append('a', `chart-type=${chartType}`)
-        return url.toString()
+    map(([viewType, config, metadata]) => {
+      const url = new URL(`${this.wcEmbedderBaseUrl}`, window.location.origin)
+      url.searchParams.set('v', `${this.version}`)
+      if (viewType === 'chart') {
+        if (config) {
+          const { aggregation, xProperty, yProperty, chartType } = config
+          url.searchParams.append('e', `gn-dataset-view-chart`)
+          url.searchParams.append('a', `aggregation=${aggregation}`)
+          url.searchParams.append('a', `x-property=${xProperty}`)
+          url.searchParams.append('a', `y-property=${yProperty}`)
+          url.searchParams.append('a', `chart-type=${chartType}`)
+        } else {
+          return ''
+        }
+      } else if (viewType === 'table') {
+        // table
+        url.searchParams.append('e', `gn-dataset-view-table`)
+      } else {
+        // map
+        url.searchParams.append('e', `gn-dataset-view-map`)
       }
-      return ''
+      url.searchParams.append('a', `api-url=${this.config.basePath}`)
+      url.searchParams.append('a', `dataset-id=${metadata.uniqueIdentifier}`)
+      url.searchParams.append('a', `primary-color=#0f4395`)
+      url.searchParams.append('a', `secondary-color=#8bc832`)
+      url.searchParams.append('a', `main-color=#555`)
+      url.searchParams.append('a', `background-color=#fdfbff`)
+      return url.toString()
     })
   )
 

package/src/libs/feature/record/src/lib/data-view-share/data-view-share.component.html

@@ -10,7 +10,9 @@
       <ng-template mat-tab-label>
         <span class="tab-header-label-gray" translate>share.tab.permalink</span>
       </ng-template>
-      <gn-ui-data-view-permalink></gn-ui-data-view-permalink>
+      <gn-ui-data-view-permalink
+        [viewType]="viewType"
+      ></gn-ui-data-view-permalink>
     </mat-tab>
     <mat-tab>
       <ng-template mat-tab-label>
@@ -24,7 +26,9 @@
           >share.tab.webComponent</span
         >
       </ng-template>
-      <gn-ui-data-view-web-component></gn-ui-data-view-web-component>
+      <gn-ui-data-view-web-component
+        [viewType]="viewType"
+      ></gn-ui-data-view-web-component>
     </mat-tab>
   </mat-tab-group>
 </div>

package/src/libs/feature/record/src/lib/data-view-share/data-view-share.component.ts

@@ -2,6 +2,7 @@ import {
   ChangeDetectionStrategy,
   Component,
   Inject,
+  Input,
   Optional,
 } from '@angular/core'
 import { WEB_COMPONENT_EMBEDDER_URL } from '../data-view-permalink/data-view-permalink.component'
@@ -13,6 +14,16 @@ import { WEB_COMPONENT_EMBEDDER_URL } from '../data-view-permalink/data-view-per
   changeDetection: ChangeDetectionStrategy.OnPush,
 })
 export class DataViewShareComponent {
+  private _viewType: string
+
+  @Input()
+  set viewType(value: string) {
+    this._viewType = value
+  }
+
+  get viewType(): string {
+    return this._viewType
+  }
   constructor(
     @Optional()
     @Inject(WEB_COMPONENT_EMBEDDER_URL)