geonetwork-ui 2.10.0-dev.270411d14 → 2.10.0-dev.2be368c45

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

@@ -1,9 +1,5 @@
 import { marker } from '@biesbjerg/ngx-translate-extract-marker'
-import {
-  EditorConfig,
-  EditorField,
-  EditorSection,
-} from './models/editor-config.model'
+import { EditorConfig } from './models/editor-config.model'
 import { Keyword } from '../../../../../libs/common/domain/src/lib/model/record'
 
 export interface ISOTopic {
@@ -12,309 +8,326 @@ export interface ISOTopic {
 }
 
 /**
- * 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.
+ * This file contains the configuration of the fields
+ * that will be displayed in the editor
+ * and the reuse light editor.
  */
 
-/************************************************************
- ***************           FIELDS           *****************
- ************************************************************
- */
-
-export const RECORD_UNIQUE_IDENTIFIER_FIELD: EditorField = {
-  model: 'uniqueIdentifier',
-  formFieldConfig: {
-    labelKey: marker('editor.record.form.field.uniqueIdentifier'),
-  },
-  hidden: true,
-}
-
-export const CONSTRAINTS_SHORTCUTS: EditorField = {
-  componentName: 'form-field-constraints-shortcuts',
-  formFieldConfig: {
-    labelKey: marker('editor.record.form.field.constraintsShortcuts'),
-  },
-}
-
-export const LEGAL_CONSTRAINTS_FIELD: EditorField = {
-  model: 'legalConstraints',
-  formFieldConfig: {
-    labelKey: marker('editor.record.form.field.legalConstraints'),
-  },
-}
-export const SECURITY_CONSTRAINTS_FIELD: EditorField = {
-  model: 'securityConstraints',
-  formFieldConfig: {
-    labelKey: marker('editor.record.form.field.securityConstraints'),
-  },
-}
-export const OTHER_CONSTRAINTS_FIELD: EditorField = {
-  model: 'otherConstraints',
-  formFieldConfig: {
-    labelKey: marker('editor.record.form.field.otherConstraints'),
-  },
-}
-
-export const RECORD_LICENSE_FIELD: EditorField = {
-  model: 'licenses',
-  formFieldConfig: {
-    labelKey: marker('editor.record.form.field.license'),
-  },
-}
-
-export const RECORD_KEYWORDS_FIELD: EditorField = {
-  model: 'keywords',
-  formFieldConfig: {},
-}
-
-export const RECORD_TOPICS_FIELD: EditorField = {
-  model: 'topics',
-  formFieldConfig: {},
-}
-
-export const RECORD_RESOURCE_CREATED_FIELD: EditorField = {
-  model: 'resourceCreated',
-  formFieldConfig: {
-    labelKey: marker('editor.record.form.field.resourceCreated'),
-  },
-  gridColumnSpan: 1,
-}
-
-export const RESOURCE_IDENTIFIER_FIELD: EditorField = {
-  model: 'resourceIdentifiers',
-  formFieldConfig: {
-    labelKey: marker('editor.record.form.field.resourceIdentifier'),
-  },
-}
-
-export const RECORD_RESOURCE_UPDATED_FIELD: EditorField = {
-  model: 'resourceUpdated',
-  formFieldConfig: {
-    labelKey: marker('editor.record.form.field.resourceUpdated'),
-  },
-  gridColumnSpan: 1,
-}
-
-export const RECORD_UPDATED_FIELD: EditorField = {
-  model: 'recordUpdated',
-  formFieldConfig: {
-    labelKey: marker('editor.record.form.field.recordUpdated'),
-  },
-  onSaveProcess: '${dateNow()}',
-  gridColumnSpan: 1,
-  hidden: true,
-}
-
-export const RECORD_UPDATE_FREQUENCY_FIELD: EditorField = {
-  model: 'updateFrequency',
-  formFieldConfig: {},
-}
-// keeping track of the label to not lose existing translation
+// keeping track of labels to not lose existing translations
 marker('editor.record.form.field.updateFrequency')
-
-export const RECORD_TEMPORAL_EXTENTS_FIELD: EditorField = {
-  model: 'temporalExtents',
-  formFieldConfig: {
-    labelKey: marker('editor.record.form.field.temporalExtents'),
-  },
-}
-
-export const RECORD_TITLE_FIELD: EditorField = {
-  model: 'title',
-  formFieldConfig: {
-    labelKey: marker('editor.record.form.field.title'),
-  },
-}
-
-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_TOGGLE_FIELD: EditorField = {
-  componentName: 'form-field-spatial-toggle',
-  formFieldConfig: {},
-  hidden: true,
-}
-
-export const RECORD_SPATIAL_EXTENTS_FIELD: EditorField = {
-  model: 'spatialExtents',
-  formFieldConfig: {},
-}
-// keeping track of the label to not lose existing translation
 marker('editor.record.form.field.spatialExtents')
-
-export const RECORD_ONLINE_RESOURCES: EditorField = {
-  model: 'onlineResources',
-  modelSpecifier: 'onlineResourceType:!link',
-  formFieldConfig: {},
-}
-// keeping track of the label to not lose existing translation
 marker('editor.record.form.field.onlineResources')
-
-export const RECORD_ONLINE_LINK_RESOURCES: EditorField = {
-  model: 'onlineResources',
-  modelSpecifier: 'onlineResourceType:link',
-  formFieldConfig: {},
-}
-// keeping track of the label to not lose existing translation
 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,
-    RESOURCE_IDENTIFIER_FIELD,
-    RECORD_RESOURCE_CREATED_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_TOGGLE_FIELD, 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: [RECORD_ONLINE_RESOURCES],
-}
-
-export const ANNEXES_SECTION: EditorSection = {
-  labelKey: marker('editor.record.form.section.annexes.label'),
-  descriptionKey: marker('editor.record.form.section.annexes.description'),
-  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 TOPICS_SECTION: EditorSection = {
-  labelKey: marker('editor.record.form.section.topics.label'),
-  descriptionKey: marker('editor.record.form.section.topics.description'),
-  hidden: false,
-  fields: [RECORD_TOPICS_FIELD],
-}
-
-export const USE_AND_ACCESS_CONDITIONS_SECTION: EditorSection = {
-  labelKey: marker('editor.record.form.section.useAndAccessConditions.label'),
-  hidden: false,
-  fields: [
-    RECORD_LICENSE_FIELD,
-    CONSTRAINTS_SHORTCUTS,
-    LEGAL_CONSTRAINTS_FIELD,
-    SECURITY_CONSTRAINTS_FIELD,
-    OTHER_CONSTRAINTS_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 METADATA_POINT_OF_CONTACT_SECTION: EditorSection = {
-  labelKey: marker('editor.record.form.section.metadataPointOfContact.label'),
-  descriptionKey: marker(
-    'editor.record.form.section.metadataPointOfContact.description'
-  ),
-  hidden: false,
-  fields: [CONTACTS],
-}
-
-/************************************************************
- ***************           PAGES            *****************
- ************************************************************
- */
 export const DEFAULT_CONFIGURATION: EditorConfig = {
   pages: [
+    /**
+     * Page 1: DESCRIPTION
+     */
+
     {
       labelKey: marker('editor.record.form.page.description'),
       sections: [
-        TITLE_SECTION,
-        CLASSIFICATION_SECTION,
-        TOPICS_SECTION,
-        ABOUT_SECTION,
-        GEOGRAPHICAL_COVERAGE_SECTION,
+        // Section: Title, abstract and overview
+        {
+          fields: [
+            {
+              model: 'title',
+              formFieldConfig: {
+                labelKey: marker('editor.record.form.field.title'),
+              },
+            },
+            {
+              model: 'abstract',
+              formFieldConfig: {
+                labelKey: marker('editor.record.form.field.abstract'),
+              },
+            },
+            {
+              model: 'overviews',
+              formFieldConfig: {
+                labelKey: marker('editor.record.form.field.overviews'),
+              },
+            },
+          ],
+        },
+
+        // Section: Classification
+        {
+          labelKey: marker('editor.record.form.section.classification.label'),
+          descriptionKey: marker(
+            'editor.record.form.section.classification.description'
+          ),
+          fields: [
+            {
+              model: 'keywords',
+              formFieldConfig: {},
+            },
+          ],
+        },
+
+        // Section: Topics
+        {
+          labelKey: marker('editor.record.form.section.topics.label'),
+          descriptionKey: marker(
+            'editor.record.form.section.topics.description'
+          ),
+          fields: [
+            {
+              model: 'topics',
+              formFieldConfig: {},
+            },
+          ],
+        },
+
+        // Section: About (identifiers, dates, update frequency, temporal extents)
+        {
+          labelKey: marker('editor.record.form.section.about.label'),
+          descriptionKey: marker(
+            'editor.record.form.section.about.description'
+          ),
+          fields: [
+            {
+              model: 'uniqueIdentifier',
+              formFieldConfig: {
+                labelKey: marker('editor.record.form.field.uniqueIdentifier'),
+              },
+              hidden: true,
+            },
+            {
+              model: 'resourceIdentifiers',
+              formFieldConfig: {
+                labelKey: marker('editor.record.form.field.resourceIdentifier'),
+              },
+            },
+            {
+              model: 'resourceCreated',
+              formFieldConfig: {
+                labelKey: marker('editor.record.form.field.resourceCreated'),
+              },
+              gridColumnSpan: 1,
+            },
+            {
+              model: 'resourceUpdated',
+              formFieldConfig: {
+                labelKey: marker('editor.record.form.field.resourceUpdated'),
+              },
+              gridColumnSpan: 1,
+            },
+            {
+              model: 'recordUpdated',
+              formFieldConfig: {
+                labelKey: marker('editor.record.form.field.recordUpdated'),
+              },
+              onSaveProcess: '${dateNow()}',
+              gridColumnSpan: 1,
+              hidden: true,
+            },
+            {
+              model: 'updateFrequency',
+              formFieldConfig: {},
+            },
+            {
+              model: 'temporalExtents',
+              formFieldConfig: {
+                labelKey: marker('editor.record.form.field.temporalExtents'),
+              },
+              hidden: '${record.kind == "service"}',
+            },
+          ],
+        },
+
+        // Section: Geographical coverage
+        {
+          labelKey: marker(
+            'editor.record.form.section.geographicalCoverage.label'
+          ),
+          fields: [
+            {
+              componentName: 'form-field-spatial-toggle',
+              formFieldConfig: {},
+              hidden: true,
+            },
+            {
+              model: 'spatialExtents',
+              formFieldConfig: {},
+            },
+          ],
+        },
       ],
     },
+
+    /**
+     * Page 2: RESOURCES
+     */
+
     {
       labelKey: marker('editor.record.form.page.resources'),
-      sections: [ASSOCIATED_RESOURCES_SECTION, ANNEXES_SECTION],
+      sections: [
+        // Section: Associated resources (distributions, services, …)
+        {
+          hidden: '${record.kind != "dataset"}',
+          labelKey: marker(
+            'editor.record.form.section.associatedResources.label'
+          ),
+          descriptionKey: marker(
+            'editor.record.form.section.associatedResources.description'
+          ),
+          fields: [
+            {
+              model: 'onlineResources',
+              modelSpecifier: 'onlineResourceType:!link',
+              formFieldConfig: {},
+            },
+          ],
+        },
+
+        // Section: Annexes (links)
+        {
+          labelKey: marker('editor.record.form.section.annexes.label'),
+          descriptionKey: marker(
+            'editor.record.form.section.annexes.description'
+          ),
+          fields: [
+            {
+              model: 'onlineResources',
+              modelSpecifier: 'onlineResourceType:link',
+              formFieldConfig: {},
+            },
+          ],
+        },
+      ],
     },
+
+    /**
+     * Page 3: ACCESS & CONTACT
+     */
+
     {
       labelKey: marker('editor.record.form.page.accessAndContact'),
       sections: [
-        USE_AND_ACCESS_CONDITIONS_SECTION,
-        DATA_MANAGERS_SECTION,
-        METADATA_POINT_OF_CONTACT_SECTION,
+        // Section: Use and access conditions (license, constraints)
+        {
+          labelKey: marker(
+            'editor.record.form.section.useAndAccessConditions.label'
+          ),
+          fields: [
+            {
+              model: 'licenses',
+              formFieldConfig: {
+                labelKey: marker('editor.record.form.field.license'),
+              },
+            },
+            {
+              componentName: 'form-field-constraints-shortcuts',
+              formFieldConfig: {
+                labelKey: marker(
+                  'editor.record.form.field.constraintsShortcuts'
+                ),
+              },
+            },
+            {
+              model: 'legalConstraints',
+              formFieldConfig: {
+                labelKey: marker('editor.record.form.field.legalConstraints'),
+              },
+            },
+            {
+              model: 'securityConstraints',
+              formFieldConfig: {
+                labelKey: marker(
+                  'editor.record.form.field.securityConstraints'
+                ),
+              },
+            },
+            {
+              model: 'otherConstraints',
+              formFieldConfig: {
+                labelKey: marker('editor.record.form.field.otherConstraints'),
+              },
+            },
+          ],
+        },
+
+        // Section: Data managers (contacts for resource)
+        {
+          labelKey: marker('editor.record.form.section.dataManagers.label'),
+          descriptionKey: marker(
+            'editor.record.form.section.dataManagers.description'
+          ),
+          fields: [
+            {
+              model: 'contactsForResource',
+              formFieldConfig: { labelKey: '' },
+            },
+          ],
+        },
+
+        // Section: Metadata point of contact
+        {
+          labelKey: marker(
+            'editor.record.form.section.metadataPointOfContact.label'
+          ),
+          descriptionKey: marker(
+            'editor.record.form.section.metadataPointOfContact.description'
+          ),
+          fields: [
+            {
+              model: 'contacts',
+              formFieldConfig: { labelKey: '' },
+            },
+          ],
+        },
       ],
     },
   ],
 }
 
-/************************************************************
- ***************           LICENSES            **************
- ************************************************************
+// reduced configuration used by the light edition page for reuse records;
+// the point of contact is edited outside the record form on that page
+export const REUSE_LIGHT_CONFIGURATION: EditorConfig = {
+  pages: [
+    {
+      sections: [
+        {
+          hidden: false,
+          fields: [
+            {
+              model: 'title',
+              formFieldConfig: {
+                labelKey: marker('editor.record.form.field.title'),
+              },
+            },
+            {
+              model: 'abstract',
+              formFieldConfig: {
+                labelKey: marker('editor.record.form.field.abstract'),
+              },
+            },
+            {
+              model: 'onlineResources',
+              modelSpecifier: 'onlineResourceType:singleLink',
+              formFieldConfig: {
+                labelKey: marker('editor.record.form.field.reuseUrl'),
+              },
+            },
+            {
+              model: 'overviews',
+              formFieldConfig: {
+                labelKey: marker('editor.record.form.field.overviews'),
+              },
+            },
+          ],
+        },
+      ],
+    },
+  ],
+}
+
+/**
+ * OTHER SETTINGS
  */
+
 export const AVAILABLE_LICENSES: string[] = [
   'cc-by',
   'cc-by-sa',
@@ -340,10 +353,6 @@ marker('editor.record.form.license.pddl')
 marker('editor.record.form.license.unknown')
 
 export const MAX_UPLOAD_SIZE_MB = 10
-/************************************************************
- ***************        SPATIAL SCOPE            ************
- ************************************************************
- */
 
 export const SPATIAL_SCOPES: Keyword[] = [
   {
@@ -360,11 +369,6 @@ export const SPATIAL_SCOPES: Keyword[] = [
   },
 ]
 
-/************************************************************
- ***************             ISO TOPICS             **************
- ************************************************************
- */
-
 // label keys mirror the ISO MD_TopicCategoryCode value for consistency
 // TODO: correctly handle code lists; for instance, this code list is specific to ISO 19139
 export const ISO_TOPICS: ISOTopic[] = [

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

@@ -19,12 +19,16 @@ export interface FormFieldConfig {
 // This is used for instance to target only certain online resources in a field
 type OnlineLinkResourceSpecifier = `onlineResourceType:link`
 type DatasetDistributionsSpecifier = `onlineResourceType:!link`
+// Renders a single URL input bound to the first online resource of the record
+// (FormFieldOnlineSingleLinkResourceComponent)
+type OnlineSingleLinkResourceSpecifier = `onlineResourceType:singleLink`
 // When set on the `contacts` field, contacts are rendered as editable detail
 // fields (ContactDetailsFormComponent) instead of cards (ContactCardComponent)
 type EditableContactDetailsSpecifier = `contact:editableDetails`
 export type FieldModelSpecifier =
   | OnlineLinkResourceSpecifier
   | DatasetDistributionsSpecifier
+  | OnlineSingleLinkResourceSpecifier
   | EditableContactDetailsSpecifier
 
 export type FormFieldComponentName =
@@ -48,8 +52,7 @@ export interface EditorField extends EditorFieldIdentification {
   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
+  hidden?: boolean | EditorFieldExpression
 
   // the result of this expression will replace the field value on save
   onSaveProcess?: EditorFieldExpression
@@ -58,7 +61,7 @@ export interface EditorField extends EditorFieldIdentification {
 export interface EditorSection {
   labelKey?: string
   descriptionKey?: string
-  hidden: boolean
+  hidden?: boolean | EditorFieldExpression
   fields: EditorField[]
 }