geonetwork-ui 2.4.0-dev.71a43b38 → 2.4.0-dev.78565730

package/src/libs/feature/editor/src/lib/+state/editor.effects.ts

@@ -6,9 +6,9 @@ import * as EditorActions from './editor.actions'
 import { EditorService } from '../services/editor.service'
 import { Store } from '@ngrx/store'
 import {
+  selectEditorConfig,
   selectRecord,
   selectRecordAlreadySavedOnce,
-  selectRecordFieldsConfig,
 } from './editor.selectors'
 import { RecordsRepositoryInterface } from '../../../../../../libs/common/domain/src/lib/repository/records-repository.interface'
 
@@ -24,7 +24,7 @@ export class EditorEffects {
       ofType(EditorActions.saveRecord),
       withLatestFrom(
         this.store.select(selectRecord),
-        this.store.select(selectRecordFieldsConfig),
+        this.store.select(selectEditorConfig),
         this.store.select(selectRecordAlreadySavedOnce)
       ),
       switchMap(([, record, fieldsConfig, alreadySavedOnce]) =>

package/src/libs/feature/editor/src/lib/+state/editor.facade.ts

@@ -25,8 +25,12 @@ export class EditorFacade {
   changedSinceSave$ = this.store.pipe(
     select(EditorSelectors.selectRecordChangedSinceSave)
   )
-  recordFields$ = this.store.pipe(select(EditorSelectors.selectRecordFields))
+  currentSections$ = this.store.pipe(
+    select(EditorSelectors.selectRecordSections)
+  )
   draftSaveSuccess$ = this.actions$.pipe(ofType(EditorActions.draftSaveSuccess))
+  currentPage$ = this.store.pipe(select(EditorSelectors.selectCurrentPage))
+  editorConfig$ = this.store.pipe(select(EditorSelectors.selectEditorConfig))
 
   openRecord(
     record: CatalogRecord,
@@ -45,4 +49,8 @@ export class EditorFacade {
   updateRecordField(field: string, value: unknown) {
     this.store.dispatch(EditorActions.updateRecordField({ field, value }))
   }
+
+  setCurrentPage(page: number) {
+    this.store.dispatch(EditorActions.setCurrentPage({ page }))
+  }
 }

package/src/libs/feature/editor/src/lib/+state/editor.models.ts

@@ -1 +1,12 @@
+import { EditorField, EditorFieldValue, EditorSection } from '../models'
+
 export type SaveRecordError = string
+
+export interface EditorFieldWithValue {
+  config: EditorField
+  value: EditorFieldValue
+}
+
+export type EditorSectionWithValues = EditorSection & {
+  fieldsWithValues: EditorFieldWithValue[]
+}

package/src/libs/feature/editor/src/lib/+state/editor.reducer.ts

@@ -2,8 +2,8 @@ import { Action, createReducer, on } from '@ngrx/store'
 import * as EditorActions from './editor.actions'
 import { CatalogRecord } from '../../../../../../libs/common/domain/src/lib/model/record'
 import { SaveRecordError } from './editor.models'
-import { EditorFieldsConfig } from '../models/fields.model'
-import { DEFAULT_FIELDS } from '../fields.config'
+import { EditorConfig } from '../models'
+import { DEFAULT_CONFIGURATION } from '../fields.config'
 
 export const EDITOR_FEATURE_KEY = 'editor'
 
@@ -13,7 +13,7 @@ export const EDITOR_FEATURE_KEY = 'editor'
  * @property saving
  * @property saveError
  * @property changedSinceSave
- * @property fieldsConfig Configuration for the fields in the editor
+ * @property editorConfig Configuration for the fields in the editor
  */
 export interface EditorState {
   record: CatalogRecord | null
@@ -22,7 +22,8 @@ export interface EditorState {
   saving: boolean
   saveError: SaveRecordError | null
   changedSinceSave: boolean
-  fieldsConfig: EditorFieldsConfig
+  editorConfig: EditorConfig
+  currentPage: number
 }
 
 export interface EditorPartialState {
@@ -36,7 +37,8 @@ export const initialEditorState: EditorState = {
   saving: false,
   saveError: null,
   changedSinceSave: false,
-  fieldsConfig: DEFAULT_FIELDS,
+  editorConfig: DEFAULT_CONFIGURATION,
+  currentPage: 0,
 }
 
 const reducer = createReducer(
@@ -77,6 +79,10 @@ const reducer = createReducer(
   on(EditorActions.markRecordAsChanged, (state) => ({
     ...state,
     changedSinceSave: true,
+  })),
+  on(EditorActions.setCurrentPage, (state, { page }) => ({
+    ...state,
+    currentPage: page,
   }))
 )
 

package/src/libs/feature/editor/src/lib/+state/editor.selectors.ts

@@ -1,5 +1,6 @@
 import { createFeatureSelector, createSelector } from '@ngrx/store'
 import { EDITOR_FEATURE_KEY, EditorState } from './editor.reducer'
+import { EditorSectionWithValues } from './editor.models'
 
 export const selectEditorState =
   createFeatureSelector<EditorState>(EDITOR_FEATURE_KEY)
@@ -34,16 +35,29 @@ export const selectRecordAlreadySavedOnce = createSelector(
   (state: EditorState) => state.alreadySavedOnce
 )
 
-export const selectRecordFieldsConfig = createSelector(
+export const selectEditorConfig = createSelector(
   selectEditorState,
-  (state: EditorState) => state.fieldsConfig
+  (state: EditorState) => state.editorConfig
 )
 
-export const selectRecordFields = createSelector(
+export const selectCurrentPage = createSelector(
   selectEditorState,
-  (state: EditorState) =>
-    state.fieldsConfig.map((fieldConfig) => ({
-      config: fieldConfig,
-      value: state.record?.[fieldConfig.model] ?? null,
-    }))
+  (state: EditorState) => state.currentPage
+)
+
+export const selectRecordSections = createSelector(
+  selectEditorState,
+  (state: EditorState) => {
+    const currentPage = state.editorConfig.pages[state.currentPage]
+    if (!currentPage) {
+      return [] as EditorSectionWithValues[]
+    }
+    return currentPage.sections.map((section) => ({
+      ...section,
+      fieldsWithValues: section.fields.map((fieldConfig) => ({
+        config: fieldConfig,
+        value: state.record?.[fieldConfig.model] ?? null,
+      })),
+    })) as EditorSectionWithValues[]
+  }
 )

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

@@ -4,8 +4,8 @@
   </ng-container>
   <ng-template #withGenericWrapper>
     <gn-ui-form-field-wrapper
-      [label]="config.labelKey | translate"
-      [hint]="config.hintKey | translate"
+      [label]="config.labelKey! | translate"
+      [hint]="config.hintKey! | translate"
     >
       <ng-container *ngTemplateOutlet="fieldContent"></ng-container>
     </gn-ui-form-field-wrapper>
@@ -15,14 +15,14 @@
 <ng-template #fieldContent>
   <ng-container *ngIf="isTitle">
     <div class="flex justify-between items-center gap-3">
-      <h2
+      <span
         #titleInput
-        class="grow text-3xl font-normal"
+        class="grow font-title text-3xl font-normal"
         [gnUiEditableLabel]="true"
         (editableLabelChanged)="formControl.setValue($event)"
       >
         {{ formControl.value }}
-      </h2>
+      </span>
       <span
         class="material-symbols-outlined gn-ui-icon-small m-2 cursor-pointer"
         (click)="focusTitleInput()"
@@ -30,7 +30,7 @@
       >
       <span
         class="material-symbols-outlined gn-ui-icon-small m-2"
-        [matTooltip]="config.hintKey | translate"
+        [matTooltip]="config.hintKey! | translate"
         matTooltipPosition="above"
       >
         help
@@ -41,14 +41,14 @@
     <gn-ui-form-field-rich
       class="h-[8rem]"
       [control]="formControl"
-      [label]="config.labelKey | translate"
-      [hint]="config.hintKey | translate"
+      [label]="config.labelKey! | translate"
+      [hint]="config.hintKey! | translate"
     ></gn-ui-form-field-rich>
   </ng-container>
   <ng-container *ngIf="isLicenses">
     <gn-ui-form-field-license
       [control]="formControl"
-      [label]="config.labelKey | translate"
+      [label]="config.labelKey! | translate"
     ></gn-ui-form-field-license>
   </ng-container>
   <ng-container *ngIf="isResourceUpdated">

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: marker('editor.record.form.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: marker('editor.record.form.abstract'),
-      type: 'rich',
-    },
+}
+
+export const RECORD_KEYWORDS_FIELD: EditorField = {
+  model: 'keywords',
+  formFieldConfig: {
+    labelKey: marker('editor.record.form.field.keywords'),
   },
-  {
-    model: 'uniqueIdentifier',
-    formFieldConfig: {
-      labelKey: marker('editor.record.form.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: marker('editor.record.form.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'