geonetwork-ui 2.4.0-dev.cec60ff1 → 2.4.0-dev.d3529f01

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

@@ -1,71 +1,261 @@
 import { marker } from '@biesbjerg/ngx-translate-extract-marker'
-import { EditorFieldsConfig } from './models/fields.model'
+import {
+  EditorConfig,
+  EditorField,
+  EditorSection,
+} from './models/editor-config.model'
+import { Keyword } from '../../../../../libs/common/domain/src/lib/model/record'
 
-export const DEFAULT_FIELDS: EditorFieldsConfig = [
-  {
-    model: 'title',
-    formFieldConfig: {
-      labelKey: 'Metadata title',
-      type: 'text',
-    },
+/**
+ * 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',
-    },
+  gridColumnSpan: 1,
+}
+
+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()}',
+  gridColumnSpan: 1,
+}
+
+export const RECORD_UPDATE_FREQUENCY_FIELD: EditorField = {
+  model: 'updateFrequency',
+  formFieldConfig: {},
+}
+// keeping track of the label to not lose existing translation
+marker('editor.record.form.field.updateFrequency')
+
+export const RECORD_TEMPORAL_EXTENTS_FIELD: EditorField = {
+  model: 'temporalExtents',
+  formFieldConfig: {
+    labelKey: marker('editor.record.form.field.temporalExtents'),
   },
-  {
-    model: 'updateFrequency',
-    formFieldConfig: {
-      labelKey: marker('editor.record.form.updateFrequency'),
-      type: 'text',
-    },
+}
+
+export const RECORD_TITLE_FIELD: EditorField = {
+  model: 'title',
+  formFieldConfig: {
+    labelKey: marker('editor.record.form.field.title'),
   },
-  {
-    model: 'temporalExtents',
-    formFieldConfig: {
-      labelKey: marker('editor.record.form.temporalExtents'),
-      type: 'list',
+}
+
+export const RECORD_ABSTRACT_FIELD: EditorField = {
+  model: 'abstract',
+  formFieldConfig: {
+    labelKey: marker('editor.record.form.field.abstract'),
+  },
+}
+
+export const CONTACTS_FOR_RESOURCE_FIELD: EditorField = {
+  model: 'contactsForResource',
+  formFieldConfig: {
+    labelKey: '',
+  },
+}
+
+export const CONTACTS: EditorField = {
+  model: 'contacts',
+  formFieldConfig: {
+    labelKey: '',
+  },
+}
+
+export const RECORD_GRAPHICAL_OVERVIEW_FIELD: EditorField = {
+  model: 'overviews',
+  formFieldConfig: {
+    labelKey: marker('editor.record.form.field.overviews'),
+  },
+}
+
+export const RECORD_SPATIAL_EXTENTS_FIELD: EditorField = {
+  model: 'spatialExtents',
+  formFieldConfig: {
+    labelKey: marker('editor.record.form.field.spatialExtents'),
+  },
+}
+
+export const RECORD_ONLINE_LINK_RESOURCES: EditorField = {
+  model: 'onlineResources',
+  modelSpecifier: 'onlineResourceType:link',
+  formFieldConfig: {
+    labelKey: marker('editor.record.form.field.onlineLinkResources'),
+  },
+}
+
+/************************************************************
+ ***************          SECTIONS          *****************
+ ************************************************************
+ */
+
+export const TITLE_SECTION: EditorSection = {
+  hidden: false,
+  fields: [
+    RECORD_TITLE_FIELD,
+    RECORD_ABSTRACT_FIELD,
+    RECORD_GRAPHICAL_OVERVIEW_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: [RECORD_SPATIAL_EXTENTS_FIELD],
+}
+
+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: [RECORD_ONLINE_LINK_RESOURCES],
+}
+
+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: [CONTACTS_FOR_RESOURCE_FIELD],
+}
+
+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: [CONTACTS],
+}
+
+/************************************************************
+ ***************           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,
+      ],
     },
+  ],
+}
+
+/************************************************************
+ ***************           LICENSES            **************
+ ************************************************************
+ */
+export const OPEN_DATA_LICENSES: string[] = [
+  'etalab',
+  'etalab-v2',
+  'odbl',
+  'odc-by',
+  'pddl',
+]
+
+export const MAX_UPLOAD_SIZE_MB = 10
+/************************************************************
+ ***************        SPATIAL SCOPE            ************
+ ************************************************************
+ */
+
+export const SPATIAL_SCOPES: Keyword[] = [
+  {
+    key: 'http://inspire.ec.europa.eu/metadata-codelist/SpatialScope/national',
+    label: 'National',
+    description: '',
+    type: 'theme',
   },
   {
-    model: 'keywords',
-    formFieldConfig: {
-      labelKey: marker('editor.record.form.keywords'),
-      type: 'list',
-    },
+    key: 'http://inspire.ec.europa.eu/metadata-codelist/SpatialScope/regional',
+    label: 'Regional',
+    description: '',
+    type: 'theme',
   },
 ]

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

@@ -0,0 +1,65 @@
+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
+}
+
+// Specifiers let us use specific components
+// This is used for instance to target only certain online resources in a field
+type OnlineLinkResourceSpecifier = `onlineResourceType:link`
+type DatasetDistributionsSpecifier = `onlineResourceType:!link`
+export type FieldModelSpecifier =
+  | OnlineLinkResourceSpecifier
+  | DatasetDistributionsSpecifier
+
+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
+  modelSpecifier?: FieldModelSpecifier
+
+  // grid column span; if unspecified, full width will be used
+  gridColumnSpan?: number
+
+  // 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,22 @@ export class EditorService {
   // returns the record as it was when saved, alongside its source
   saveRecord(
     record: CatalogRecord,
-    fieldsConfig: EditorFieldsConfig,
+    recordSource: string,
+    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],
         })
       }
@@ -36,7 +41,7 @@ export class EditorService {
       savedRecord.uniqueIdentifier = null
     }
 
-    return this.recordsRepository.saveRecord(savedRecord).pipe(
+    return this.recordsRepository.saveRecord(savedRecord, recordSource).pipe(
       switchMap((uniqueIdentifier) =>
         this.recordsRepository.openRecordForEdition(uniqueIdentifier)
       ),
@@ -50,9 +55,19 @@ export class EditorService {
 
   // emits and completes once saving is done
   // note: onSave processes are not run for drafts
-  saveRecordAsDraft(record: CatalogRecord): Observable<void> {
+  saveRecordAsDraft(
+    record: CatalogRecord,
+    recordSource: string
+  ): Observable<void> {
     return this.recordsRepository
-      .saveRecordAsDraft(record)
+      .saveRecordAsDraft(record, recordSource)
       .pipe(map(() => undefined))
   }
+
+  undoRecordDraft(
+    record: CatalogRecord
+  ): Observable<[CatalogRecord, string, boolean]> {
+    this.recordsRepository.clearRecordDraft(record.uniqueIdentifier)
+    return this.recordsRepository.openRecordForEdition(record.uniqueIdentifier)
+  }
 }

package/src/libs/feature/map/src/index.ts

@@ -1,20 +1,13 @@
 export * from './lib/+state/map.facade'
-export * from './lib/+state/map.models'
 export * from './lib/+state/map.selectors'
 export * from './lib/+state/map.reducer'
 export * from './lib/+state/map.actions'
 export * from './lib/feature-map.module'
-export * from './lib/manager/map-manager.service'
-export * from './lib/manager/map-instance.directive'
-export * from './lib/feature-info/feature-info.service'
-export * from './lib/map-context/map-context.model'
-export * from './lib/map-context/map-context.service'
-export * from './lib/map-context/component/map-context.component'
+export * from './lib/map-state-container/map-state-container.component'
 export * from './lib/constant'
 export * from './lib/utils'
 export * from './lib/style'
 export * from './lib/layers-panel/layers-panel.component'
 export * from './lib/add-layer-from-catalog/add-layer-from-catalog.component'
 export * from './lib/add-layer-from-catalog/add-layer-record-preview/add-layer-record-preview.component'
-export * from './lib/map-container/map-container.component'
 export * from './lib/geocoding/geocoding.component'

package/src/libs/feature/map/src/lib/+state/map.actions.ts

@@ -1,32 +1,17 @@
 import { createAction, props } from '@ngrx/store'
-import { MapLayer } from './map.models'
+import { MapContext } from '@geospatial-sdk/core'
+import type { Feature } from 'geojson'
 
-export const addLayer = createAction(
-  '[Map] Add Layer',
-  props<{ layer: MapLayer; atIndex?: number }>()
+export const setContext = createAction(
+  '[Map] Set Context',
+  props<{ context: MapContext }>()
 )
 
-export const removeLayer = createAction(
-  '[Map] Remove Layer',
-  props<{ index: number }>()
+export const setSelectedFeatures = createAction(
+  '[Map] Set Selected Features',
+  props<{ selectedFeatures: Feature[] }>()
 )
 
-export const updateLayer = createAction(
-  '[Map] Update Layer',
-  props<{ updatedLayer: MapLayer; index: number }>()
-)
-
-export const changeLayerOrder = createAction(
-  '[Map] Change Layer Order',
-  props<{ currentIndex: number; newIndex: number }>()
-)
-
-export const setLayerError = createAction(
-  '[Map] Set Layer Error',
-  props<{ index: number; error: string }>()
-)
-
-export const clearLayerError = createAction(
-  '[Map] Clear Layer Error',
-  props<{ index: number }>()
+export const clearSelectedFeatures = createAction(
+  '[Map] Clear Selected Features'
 )

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

@@ -1,30 +1,26 @@
 import { Injectable } from '@angular/core'
 import { select, Store } from '@ngrx/store'
 import * as MapSelectors from './map.selectors'
-import { MapLayer } from './map.models'
 import * as MapActions from './map.actions'
+import { MapContext } from '@geospatial-sdk/core'
+import { Feature } from 'geojson'
 
 @Injectable()
 export class MapFacade {
-  layers$ = this.store.pipe(select(MapSelectors.getMapLayers))
+  context$ = this.store.pipe(select(MapSelectors.getMapContext))
+  selectedFeatures$ = this.store.pipe(select(MapSelectors.getSelectedFeatures))
 
   constructor(private readonly store: Store) {}
 
-  /**
-   * Use the initialization action to perform one
-   * or more tasks in your Effects.
-   */
-  init() {
-    // placeholder
+  applyContext(context: MapContext) {
+    this.store.dispatch(MapActions.setContext({ context }))
   }
 
-  addLayer(layer: MapLayer) {
-    this.store.dispatch(MapActions.addLayer({ layer }))
+  selectFeatures(selectedFeatures: Feature[]) {
+    this.store.dispatch(MapActions.setSelectedFeatures({ selectedFeatures }))
   }
-  addLayerAtIndex(layer: MapLayer, index: number) {
-    this.store.dispatch(MapActions.addLayer({ layer, atIndex: index }))
-  }
-  removeLayer(index: number) {
-    this.store.dispatch(MapActions.removeLayer({ index }))
+
+  clearFeatureSelection() {
+    this.store.dispatch(MapActions.clearSelectedFeatures())
   }
 }

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

@@ -1,12 +1,13 @@
 import { Action, createReducer, on } from '@ngrx/store'
-
 import * as MapActions from './map.actions'
-import { MapLayerWithInfo } from './map.models'
+import { MapContext } from '@geospatial-sdk/core'
+import { Feature } from 'geojson'
 
 export const MAP_FEATURE_KEY = 'map'
 
 export interface MapState {
-  layers: MapLayerWithInfo[]
+  context: MapContext
+  selectedFeatures: Feature[]
 }
 
 export interface MapPartialState {
@@ -14,68 +15,30 @@ export interface MapPartialState {
 }
 
 export const initialMapState: MapState = {
-  layers: [],
+  context: { layers: [], view: null },
+  selectedFeatures: [],
 }
 
 const reducer = createReducer(
   initialMapState,
-  on(MapActions.addLayer, (state, action) => {
-    const layers: MapLayerWithInfo[] = [...state.layers]
-    const layerWithInfo = { ...action.layer, loading: false, error: null }
-    if (!('atIndex' in action)) layers.push(layerWithInfo)
-    else layers.splice(action.atIndex, 0, layerWithInfo)
+  on(MapActions.setContext, (state, { context }) => {
     return {
       ...state,
-      layers,
+      context,
     }
   }),
-  on(MapActions.updateLayer, (state, action) => ({
-    ...state,
-    layers: state.layers.map((layer, index) =>
-      index === action.index
-        ? {
-            ...action.updatedLayer,
-            loading: false,
-            error: null,
-          }
-        : layer
-    ),
-  })),
-  on(MapActions.removeLayer, (state, action) => ({
-    ...state,
-    layers: state.layers.filter((layer, index) => index !== action.index),
-  })),
-  on(MapActions.changeLayerOrder, (state, action) => {
-    const layers: MapLayerWithInfo[] = [...state.layers]
-    const moved = layers.splice(action.currentIndex, 1)[0]
-    layers.splice(action.newIndex, 0, moved)
+  on(MapActions.setSelectedFeatures, (state, { selectedFeatures }) => {
     return {
       ...state,
-      layers,
+      selectedFeatures,
     }
   }),
-  on(MapActions.setLayerError, (state, action) => ({
-    ...state,
-    layers: state.layers.map((layer, index) =>
-      index === action.index
-        ? {
-            ...layer,
-            error: action.error,
-          }
-        : layer
-    ),
-  })),
-  on(MapActions.clearLayerError, (state, action) => ({
-    ...state,
-    layers: state.layers.map((layer, index) =>
-      index === action.index
-        ? {
-            ...layer,
-            error: null,
-          }
-        : layer
-    ),
-  }))
+  on(MapActions.clearSelectedFeatures, (state) => {
+    return {
+      ...state,
+      selectedFeatures: [],
+    }
+  })
 )
 
 export function mapReducer(state: MapState | undefined, action: Action) {

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

@@ -4,7 +4,12 @@ import { MAP_FEATURE_KEY, MapState } from './map.reducer'
 // Lookup the 'Map' feature state managed by NgRx
 export const getMapState = createFeatureSelector<MapState>(MAP_FEATURE_KEY)
 
-export const getMapLayers = createSelector(
+export const getMapContext = createSelector(
   getMapState,
-  (state: MapState) => state.layers
+  (state: MapState) => state.context
+)
+
+export const getSelectedFeatures = createSelector(
+  getMapState,
+  (state: MapState) => state.selectedFeatures
 )