geonetwork-ui 2.3.2 → 2.4.0-alpha.1

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

@@ -1,16 +1,23 @@
 import { inject, Injectable } from '@angular/core'
 import { Actions, createEffect, ofType } from '@ngrx/effects'
-import { of, withLatestFrom } from 'rxjs'
+import { debounceTime, filter, of, withLatestFrom } from 'rxjs'
 import { catchError, map, switchMap } from 'rxjs/operators'
 import * as EditorActions from './editor.actions'
 import { EditorService } from '../services/editor.service'
 import { Store } from '@ngrx/store'
-import { selectRecord, selectRecordFieldsConfig } from './editor.selectors'
+import {
+  selectEditorConfig,
+  selectRecord,
+  selectRecordAlreadySavedOnce,
+  selectRecordSource,
+} from './editor.selectors'
+import { RecordsRepositoryInterface } from '../../../../../../libs/common/domain/src/lib/repository/records-repository.interface'
 
 @Injectable()
 export class EditorEffects {
   private actions$ = inject(Actions)
   private editorService = inject(EditorService)
+  private recordsRepository = inject(RecordsRepositoryInterface)
   private store = inject(Store)
 
   saveRecord$ = createEffect(() =>
@@ -18,24 +25,32 @@ export class EditorEffects {
       ofType(EditorActions.saveRecord),
       withLatestFrom(
         this.store.select(selectRecord),
-        this.store.select(selectRecordFieldsConfig)
+        this.store.select(selectRecordSource),
+        this.store.select(selectEditorConfig),
+        this.store.select(selectRecordAlreadySavedOnce)
       ),
-      switchMap(([, record, fieldsConfig]) =>
-        this.editorService.saveRecord(record, fieldsConfig).pipe(
-          switchMap((newRecord) =>
-            of(
-              EditorActions.saveRecordSuccess(),
-              EditorActions.openRecord({ record: newRecord })
-            )
-          ),
-          catchError((error) =>
-            of(
-              EditorActions.saveRecordFailure({
-                error: error.message,
-              })
+      switchMap(([, record, recordSource, fieldsConfig, alreadySavedOnce]) =>
+        this.editorService
+          .saveRecord(record, recordSource, fieldsConfig, !alreadySavedOnce)
+          .pipe(
+            switchMap(([record, recordSource]) =>
+              of(
+                EditorActions.saveRecordSuccess(),
+                EditorActions.openRecord({
+                  record,
+                  alreadySavedOnce: true,
+                  recordSource,
+                })
+              )
+            ),
+            catchError((error) =>
+              of(
+                EditorActions.saveRecordFailure({
+                  error: error.message,
+                })
+              )
             )
           )
-        )
       )
     )
   )
@@ -46,4 +61,45 @@ export class EditorEffects {
       map(() => EditorActions.markRecordAsChanged())
     )
   )
+
+  saveRecordDraft$ = createEffect(() =>
+    this.actions$.pipe(
+      ofType(EditorActions.updateRecordField),
+      debounceTime(1000),
+      withLatestFrom(
+        this.store.select(selectRecord),
+        this.store.select(selectRecordSource)
+      ),
+      switchMap(([, record, recordSource]) =>
+        this.editorService.saveRecordAsDraft(record, recordSource)
+      ),
+      map(() => EditorActions.draftSaveSuccess())
+    )
+  )
+
+  undoRecordDraft$ = createEffect(() =>
+    this.actions$.pipe(
+      ofType(EditorActions.undoRecordDraft),
+      withLatestFrom(this.store.select(selectRecord)),
+      switchMap(([, record]) => this.editorService.undoRecordDraft(record)),
+      map(([record, recordSource, alreadySavedOnce]) =>
+        EditorActions.openRecord({
+          record,
+          alreadySavedOnce,
+          recordSource,
+        })
+      )
+    )
+  )
+
+  checkHasChangesOnOpen$ = createEffect(() =>
+    this.actions$.pipe(
+      ofType(EditorActions.openRecord),
+      map(({ record }) =>
+        this.recordsRepository.recordHasDraft(record.uniqueIdentifier)
+      ),
+      filter((hasDraft) => hasDraft),
+      map(() => EditorActions.markRecordAsChanged())
+    )
+  )
 }

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

@@ -3,7 +3,7 @@ import { select, Store } from '@ngrx/store'
 import * as EditorActions from './editor.actions'
 import * as EditorSelectors from './editor.selectors'
 import { CatalogRecord } from '../../../../../../libs/common/domain/src/lib/model/record'
-import { filter, Observable } from 'rxjs'
+import { filter } from 'rxjs'
 import { Actions, ofType } from '@ngrx/effects'
 
 @Injectable()
@@ -12,6 +12,10 @@ export class EditorFacade {
   private actions$ = inject(Actions)
 
   record$ = this.store.pipe(select(EditorSelectors.selectRecord))
+  recordSource$ = this.store.pipe(select(EditorSelectors.selectRecordSource))
+  alreadySavedOnce$ = this.store.pipe(
+    select(EditorSelectors.selectRecordAlreadySavedOnce)
+  )
   saving$ = this.store.pipe(select(EditorSelectors.selectRecordSaving))
   saveError$ = this.store.pipe(
     select(EditorSelectors.selectRecordSaveError),
@@ -21,17 +25,36 @@ 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) {
-    this.store.dispatch(EditorActions.openRecord({ record }))
+  openRecord(
+    record: CatalogRecord,
+    recordSource: string,
+    alreadySavedOnce: boolean
+  ) {
+    this.store.dispatch(
+      EditorActions.openRecord({ record, recordSource, alreadySavedOnce })
+    )
   }
 
   saveRecord() {
     this.store.dispatch(EditorActions.saveRecord())
   }
 
+  undoRecordDraft() {
+    this.store.dispatch(EditorActions.undoRecordDraft())
+  }
+
   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,17 +2,28 @@ 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'
 
+/**
+ * @property record The record being edited
+ * @property recordSource Original representation of the record as text, used as a reference; null means the record hasn't be serialized yet
+ * @property saving
+ * @property saveError
+ * @property changedSinceSave
+ * @property editorConfig Configuration for the fields in the editor
+ */
 export interface EditorState {
   record: CatalogRecord | null
+  recordSource: string | null
+  alreadySavedOnce: boolean
   saving: boolean
   saveError: SaveRecordError | null
   changedSinceSave: boolean
-  fieldsConfig: EditorFieldsConfig
+  editorConfig: EditorConfig
+  currentPage: number
 }
 
 export interface EditorPartialState {
@@ -21,19 +32,27 @@ export interface EditorPartialState {
 
 export const initialEditorState: EditorState = {
   record: null,
+  recordSource: null,
+  alreadySavedOnce: false,
   saving: false,
   saveError: null,
   changedSinceSave: false,
-  fieldsConfig: DEFAULT_FIELDS,
+  editorConfig: DEFAULT_CONFIGURATION,
+  currentPage: 0,
 }
 
 const reducer = createReducer(
   initialEditorState,
-  on(EditorActions.openRecord, (state, { record }) => ({
-    ...state,
-    changedSinceSave: false,
-    record,
-  })),
+  on(
+    EditorActions.openRecord,
+    (state, { record, recordSource, alreadySavedOnce }) => ({
+      ...state,
+      changedSinceSave: false,
+      recordSource: recordSource ?? null,
+      alreadySavedOnce,
+      record,
+    })
+  ),
   on(EditorActions.saveRecord, (state) => ({
     ...state,
     saving: true,
@@ -60,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)
@@ -9,6 +10,11 @@ export const selectRecord = createSelector(
   (state: EditorState) => state.record
 )
 
+export const selectRecordSource = createSelector(
+  selectEditorState,
+  (state: EditorState) => state.recordSource
+)
+
 export const selectRecordSaving = createSelector(
   selectEditorState,
   (state: EditorState) => state.saving
@@ -24,16 +30,34 @@ export const selectRecordChangedSinceSave = createSelector(
   (state: EditorState) => state.changedSinceSave
 )
 
-export const selectRecordFieldsConfig = createSelector(
+export const selectRecordAlreadySavedOnce = createSelector(
+  selectEditorState,
+  (state: EditorState) => state.alreadySavedOnce
+)
+
+export const selectEditorConfig = createSelector(
+  selectEditorState,
+  (state: EditorState) => state.editorConfig
+)
+
+export const selectCurrentPage = createSelector(
   selectEditorState,
-  (state: EditorState) => state.fieldsConfig
+  (state: EditorState) => state.currentPage
 )
 
-export const selectRecordFields = createSelector(
+export const selectRecordSections = createSelector(
   selectEditorState,
-  (state: EditorState) =>
-    state.fieldsConfig.map((fieldConfig) => ({
-      config: fieldConfig,
-      value: state.record?.[fieldConfig.model] || null,
-    }))
+  (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/contact-card/contact-card.component.html

@@ -0,0 +1,15 @@
+<div class="gn-ui-card">
+  <gn-ui-thumbnail
+    class="w-[56px] h-[56px] rounded-[4px] overflow-hidden shrink-0"
+    [thumbnailUrl]="contact.organization?.logoUrl?.href"
+    [fit]="'contain'"
+  ></gn-ui-thumbnail>
+  <div class="flex flex-col w-full overflow-hidden leading-snug">
+    <div class="text-[16px] font-bold text-main" data-test="contactCardName">
+      {{ contact.firstName }} {{ contact.lastName }}
+    </div>
+    <div class="text-[14px] text-gray-900" data-test="contactCardEmail">
+      {{ contact.email }}
+    </div>
+  </div>
+</div>

package/src/libs/feature/editor/src/lib/components/contact-card/contact-card.component.ts

@@ -0,0 +1,18 @@
+import { ChangeDetectionStrategy, Component, Input } from '@angular/core'
+import { Individual } from '../../../../../../../libs/common/domain/src/lib/model/record'
+import { MatIconModule } from '@angular/material/icon'
+import { CommonModule } from '@angular/common'
+import { ButtonComponent } from '../../../../../../../libs/ui/inputs/src'
+import { ThumbnailComponent } from '../../../../../../../libs/ui/elements/src'
+
+@Component({
+  selector: 'gn-ui-contact-card',
+  templateUrl: './contact-card.component.html',
+  styleUrls: ['./contact-card.component.css'],
+  changeDetection: ChangeDetectionStrategy.OnPush,
+  standalone: true,
+  imports: [CommonModule, MatIconModule, ButtonComponent, ThumbnailComponent],
+})
+export class ContactCardComponent {
+  @Input() contact: Individual
+}

package/src/libs/feature/editor/src/lib/components/generic-keywords/generic-keywords.component.html

@@ -0,0 +1,26 @@
+<div class="flex flex-col gap-3">
+  <gn-ui-autocomplete
+    [placeholder]="placeholder"
+    [displayWithFn]="displayWithFn"
+    [action]="autoCompleteAction"
+    (itemSelected)="handleItemSelection($event)"
+    [preventCompleteOnSelection]="true"
+    [minCharacterCount]="0"
+    [allowSubmit]="false"
+  ></gn-ui-autocomplete>
+  <div class="flex gap-2 flex-wrap">
+    <gn-ui-badge
+      *ngFor="let keyword of keywords"
+      [removable]="true"
+      (badgeRemoveClicked)="removeKeyword(keyword)"
+      >{{ keyword.label }}
+
+      <mat-icon
+        *ngIf="isPlaceWithoutExtent(keyword)"
+        [title]="'editor.form.placeKeywordWithoutExtent' | translate"
+        class="material-symbols-outlined"
+        >warning</mat-icon
+      >
+    </gn-ui-badge>
+  </div>
+</div>

package/src/libs/feature/editor/src/lib/components/generic-keywords/generic-keywords.component.ts

@@ -0,0 +1,90 @@
+import { CommonModule } from '@angular/common'
+import {
+  ChangeDetectionStrategy,
+  Component,
+  EventEmitter,
+  Input,
+  Output,
+} from '@angular/core'
+import { PlatformServiceInterface } from '../../../../../../../libs/common/domain/src/lib/platform.service.interface'
+import {
+  AutocompleteComponent,
+  DropdownSelectorComponent,
+  UiInputsModule,
+} from '../../../../../../../libs/ui/inputs/src'
+import { UiWidgetsModule } from '../../../../../../../libs/ui/widgets/src'
+import { map } from 'rxjs'
+import { Keyword } from '../../../../../../../libs/common/domain/src/lib/model/record'
+import { KeywordType } from '../../../../../../../libs/common/domain/src/lib/model/thesaurus'
+import { MatIconModule } from '@angular/material/icon'
+import { TranslateModule } from '@ngx-translate/core'
+
+type AutocompleteItem = { title: string; value: Keyword }
+
+@Component({
+  selector: 'gn-ui-generic-keywords',
+  templateUrl: './generic-keywords.component.html',
+  styleUrls: ['./generic-keywords.component.css'],
+  changeDetection: ChangeDetectionStrategy.OnPush,
+  standalone: true,
+  imports: [
+    DropdownSelectorComponent,
+    UiInputsModule,
+    CommonModule,
+    UiWidgetsModule,
+    AutocompleteComponent,
+    MatIconModule,
+    TranslateModule,
+  ],
+})
+export class GenericKeywordsComponent {
+  @Input() keywords: Keyword[]
+  @Input() keywordTypes: KeywordType[]
+  @Input() placeholder: string
+  @Input() allowSubmit: boolean
+  @Output() changedKeywords: EventEmitter<Keyword[]> = new EventEmitter()
+  @Output() addedKeyword: EventEmitter<Keyword> = new EventEmitter()
+  @Output() deletedKeyword: EventEmitter<Keyword> = new EventEmitter()
+
+  displayWithFn = (item: AutocompleteItem) => {
+    return `${item.title} (${item.value.thesaurus?.name})`
+  }
+
+  autoCompleteAction = (query: string) => {
+    return this.platformService.searchKeywords(query, this.keywordTypes).pipe(
+      map((keywords) =>
+        keywords.map((keyword) => {
+          return { title: keyword.label, value: keyword }
+        })
+      )
+    )
+  }
+
+  constructor(private platformService: PlatformServiceInterface) {}
+
+  handleItemSelection(item: AutocompleteItem) {
+    this.addKeyword(item.value)
+  }
+
+  addKeyword(keyword: Keyword) {
+    const duplicatedKeyword = this.keywords.find(
+      (k) => k.label === keyword.label
+    )
+    if (!duplicatedKeyword) {
+      this.keywords = [...this.keywords, keyword]
+      this.changedKeywords.emit(this.keywords)
+      this.addedKeyword.emit(keyword)
+    }
+  }
+
+  removeKeyword(keyword: Keyword) {
+    this.keywords = this.keywords.filter((k) => k.label !== keyword.label)
+    this.changedKeywords.emit(this.keywords)
+    this.deletedKeyword.emit(keyword)
+  }
+
+  isPlaceWithoutExtent(keyword: Keyword): boolean {
+    if (keyword.type !== 'place') return false
+    return !keyword.bbox
+  }
+}

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

@@ -0,0 +1,47 @@
+<ng-container [ngSwitch]="sectionDisplayed">
+  <ng-container *ngSwitchCase="'mainMenu'">
+    <div
+      data-test="importMenuMainSection"
+      class="mt-2 border border-gray-100 p-2 flex items-center bg-white shadow-2xl rounded-2xl"
+    >
+      <ul class="flex flex-col gap-2 w-full">
+        <li *ngFor="let menuItem of importMenuItems">
+          <gn-ui-button
+            [attr.data-test]="menuItem.dataTest"
+            type="light"
+            extraClass="flex flex-row items-center gap-2 w-full justify-start"
+            (buttonClick)="menuItem.action()"
+            [disabled]="menuItem.disabled"
+            [title]="
+              (menuItem.disabled ? 'editor.temporary.disabled' : '') | translate
+            "
+            ><mat-icon class="material-symbols-outlined">
+              {{ menuItem.icon }} </mat-icon
+            ><span>{{ menuItem.label }}</span></gn-ui-button
+          >
+        </li>
+      </ul>
+    </div>
+  </ng-container>
+  <ng-container *ngSwitchCase="'importExternalFile'">
+    <div
+      data-test="importMenuImportExternalFileSection"
+      class="p-6 flex flex-col gap-2 mt-2 border border-gray-100 bg-white shadow-2xl rounded-2xl"
+    >
+      <div class="flex flex-row items-center gap-2">
+        <gn-ui-button
+          data-test="importMenuImportExternalFileSectionBackButton"
+          type="light"
+          (buttonClick)="displayMainMenu()"
+        >
+          <mat-icon class="material-symbols-outlined">arrow_back</mat-icon>
+        </gn-ui-button>
+        <span class="font-bold"> {{ externalImportBackLabel }}</span>
+      </div>
+      <gn-ui-url-input
+        (valueChange)="importRecord($event)"
+        [disabled]="isRecordImportInProgress"
+      ></gn-ui-url-input>
+    </div>
+  </ng-container>
+</ng-container>

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

@@ -0,0 +1,132 @@
+import {
+  ChangeDetectionStrategy,
+  ChangeDetectorRef,
+  Component,
+  EventEmitter,
+  Output,
+} from '@angular/core'
+import { MatIconModule } from '@angular/material/icon'
+import { CommonModule } from '@angular/common'
+import { ButtonComponent, UrlInputComponent } from '../../../../../../../libs/ui/inputs/src'
+import { ThumbnailComponent } from '../../../../../../../libs/ui/elements/src'
+import { TranslateModule, TranslateService } from '@ngx-translate/core'
+import { NotificationsService } from '../../../../../../../libs/feature/notifications/src'
+import { RecordsRepositoryInterface } from '../../../../../../../libs/common/domain/src/lib/repository/records-repository.interface'
+import { Router } from '@angular/router'
+
+interface ImportMenuItems {
+  label: string
+  icon: string
+  action: () => any
+  dataTest: string
+  disabled?: boolean
+}
+
+type ImportMenuPage = 'mainMenu' | 'importExternalFile'
+
+@Component({
+  selector: 'gn-ui-import-record',
+  templateUrl: './import-record.component.html',
+  styleUrls: ['./import-record.component.css'],
+  changeDetection: ChangeDetectionStrategy.OnPush,
+  standalone: true,
+  imports: [
+    CommonModule,
+    MatIconModule,
+    ButtonComponent,
+    ThumbnailComponent,
+    UrlInputComponent,
+    TranslateModule,
+  ],
+})
+export class ImportRecordComponent {
+  @Output() closeImportMenu = new EventEmitter<void>()
+
+  importMenuItems: ImportMenuItems[] = [
+    {
+      label: this.translateService.instant('dashboard.importRecord.useModel'),
+      icon: 'highlight',
+      action: () => null,
+      dataTest: 'useAModelButton',
+      disabled: true,
+    },
+    {
+      label: this.translateService.instant(
+        'dashboard.importRecord.importExternal'
+      ),
+      icon: 'cloud_download',
+      action: this.displayImportExternal.bind(this),
+      dataTest: 'importFromUrlButton',
+    },
+  ]
+
+  isRecordImportInProgress = false
+
+  sectionDisplayed: ImportMenuPage = 'mainMenu'
+
+  externalImportBackLabel = this.translateService.instant(
+    'dashboard.importRecord.importExternalLabel'
+  )
+
+  constructor(
+    private router: Router,
+    private translateService: TranslateService,
+    private cdr: ChangeDetectorRef,
+    private notificationsService: NotificationsService,
+    private recordsRepository: RecordsRepositoryInterface
+  ) {}
+
+  displayMainMenu() {
+    this.sectionDisplayed = 'mainMenu'
+    this.cdr.markForCheck()
+  }
+
+  displayImportExternal() {
+    this.sectionDisplayed = 'importExternalFile'
+    this.cdr.markForCheck()
+  }
+
+  importRecord(url: string) {
+    this.isRecordImportInProgress = true
+
+    this.recordsRepository.duplicateExternalRecord(url).subscribe({
+      next: (recordTempId) => {
+        if (recordTempId) {
+          this.notificationsService.showNotification(
+            {
+              type: 'success',
+              title: this.translateService.instant(
+                'editor.record.importFromExternalFile.success.title'
+              ),
+              text: `${this.translateService.instant(
+                'editor.record.importFromExternalFile.success.body'
+              )}`,
+            },
+            2500
+          )
+
+          this.router
+            .navigate(['/edit', recordTempId])
+            .catch((err) => console.error(err))
+        }
+        this.closeImportMenu.next()
+      },
+      error: (error) => {
+        this.notificationsService.showNotification(
+          {
+            type: 'error',
+            title: this.translateService.instant(
+              'editor.record.importFromExternalFile.failure.title'
+            ),
+            text: `${this.translateService.instant(
+              'editor.record.importFromExternalFile.failure.body'
+            )} ${error.message ?? ''}`,
+          },
+          2500
+        )
+        this.isRecordImportInProgress = false
+        this.cdr.markForCheck()
+      },
+    })
+  }
+}