geonetwork-ui 2.3.0-dev.ff2a9db7 → 2.4.0-dev.573bccd7

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "geonetwork-ui",
-  "version": "2.3.0-dev.ff2a9db7",
+  "version": "2.4.0-dev.573bccd7",
   "engines": {
     "node": ">=14.17.0"
   },
@@ -47,7 +47,7 @@
   },
   "dependencies": {
     "@biesbjerg/ngx-translate-extract-marker": "^1.0.0",
-    "@camptocamp/ogc-client": "1.1.1-dev.ddbb5b0",
+    "@camptocamp/ogc-client": "1.1.1-dev.ad6d9ab",
     "@geospatial-sdk/geocoding": "^0.0.5-alpha.2",
     "@ltd/j-toml": "~1.35.2",
     "@messageformat/core": "^3.0.1",

package/src/libs/api/metadata-converter/src/lib/fixtures/generic.records.ts

@@ -195,7 +195,15 @@ As such, **it is not very interesting at all.**`,
     },
   ],
   spatialExtents: [],
-  temporalExtents: [],
+  temporalExtents: [
+    {
+      start: new Date('2024-05-24'),
+      end: null,
+    },
+    {
+      start: new Date('2024-05-30'),
+    },
+  ],
   updateFrequency: {
     updatedTimes: 3,
     per: 'month',

package/src/libs/api/metadata-converter/src/lib/iso19115-3/iso19115-3.converter.ts

@@ -1,4 +1,7 @@
+import { CatalogRecord } from '../../../../../../libs/common/domain/src/lib/model/record'
+import { XmlElement } from '@rgrove/parse-xml'
 import { Iso19139Converter } from '../iso19139'
+import { renameElements } from '../xml-utils'
 import {
   readContacts,
   readDistributions,
@@ -30,9 +33,6 @@ import {
   writeStatus,
   writeUniqueIdentifier,
 } from './write-parts'
-import { XmlElement } from '@rgrove/parse-xml'
-import { renameElements } from '../xml-utils'
-import { CatalogRecord } from '../../../../../../libs/common/domain/src/lib/model/record'
 
 export class Iso191153Converter extends Iso19139Converter {
   constructor() {

package/src/libs/api/metadata-converter/src/lib/iso19139/iso19139.converter.ts

@@ -4,6 +4,9 @@ import {
   DatasetRecord,
   ServiceRecord,
 } from '../../../../../../libs/common/domain/src/lib/model/record'
+import { XmlElement } from '@rgrove/parse-xml'
+import { BaseConverter } from '../base.converter'
+import { isEqual } from '../convert-utils'
 import {
   createDocument,
   createElement,
@@ -11,32 +14,6 @@ import {
   parseXmlString,
   xmlToString,
 } from '../xml-utils'
-import {
-  writeAbstract,
-  writeContacts,
-  writeContactsForResource,
-  writeDistributions,
-  writeGraphicOverviews,
-  writeKeywords,
-  writeKind,
-  writeLegalConstraints,
-  writeLicenses,
-  writeLineage,
-  writeOnlineResources,
-  writeOtherConstraints,
-  writeOwnerOrganization,
-  writeRecordUpdated,
-  writeResourceCreated,
-  writeResourcePublished,
-  writeResourceUpdated,
-  writeSecurityConstraints,
-  writeSpatialRepresentation,
-  writeStatus,
-  writeTitle,
-  writeTopics,
-  writeUniqueIdentifier,
-  writeUpdateFrequency,
-} from './write-parts'
 import {
   readAbstract,
   readContacts,
@@ -59,13 +36,38 @@ import {
   readSecurityConstraints,
   readSpatialRepresentation,
   readStatus,
+  readTemporalExtents,
   readTitle,
   readUniqueIdentifier,
   readUpdateFrequency,
 } from './read-parts'
-import { isEqual } from '../convert-utils'
-import { BaseConverter } from '../base.converter'
-import { XmlElement } from '@rgrove/parse-xml'
+import {
+  writeAbstract,
+  writeContacts,
+  writeContactsForResource,
+  writeDistributions,
+  writeGraphicOverviews,
+  writeKeywords,
+  writeKind,
+  writeLegalConstraints,
+  writeLicenses,
+  writeLineage,
+  writeOnlineResources,
+  writeOtherConstraints,
+  writeOwnerOrganization,
+  writeRecordUpdated,
+  writeResourceCreated,
+  writeResourcePublished,
+  writeResourceUpdated,
+  writeSecurityConstraints,
+  writeSpatialRepresentation,
+  writeStatus,
+  writeTemporalExtents,
+  writeTitle,
+  writeTopics,
+  writeUniqueIdentifier,
+  writeUpdateFrequency,
+} from './write-parts'
 
 export class Iso19139Converter extends BaseConverter<string> {
   protected readers: Record<
@@ -98,9 +100,9 @@ export class Iso19139Converter extends BaseConverter<string> {
     lineage: readLineage,
     distributions: readDistributions,
     onlineResources: readOnlineResources,
+    temporalExtents: readTemporalExtents,
     // TODO
     spatialExtents: () => [],
-    temporalExtents: () => [],
     extras: () => undefined,
     landingPage: () => undefined,
     languages: () => [],
@@ -136,9 +138,9 @@ export class Iso19139Converter extends BaseConverter<string> {
     lineage: writeLineage,
     distributions: writeDistributions,
     onlineResources: writeOnlineResources,
+    temporalExtents: writeTemporalExtents,
     // TODO
     spatialExtents: () => undefined,
-    temporalExtents: () => undefined,
     extras: () => undefined,
     landingPage: () => undefined,
     languages: () => undefined,
@@ -311,6 +313,8 @@ export class Iso19139Converter extends BaseConverter<string> {
       fieldChanged('spatialRepresentation') &&
         this.writers['spatialRepresentation'](record, rootEl)
       fieldChanged('overviews') && this.writers['overviews'](record, rootEl)
+      fieldChanged('temporalExtents') &&
+        this.writers['temporalExtents'](record, rootEl)
       fieldChanged('distributions') &&
         this.writers['distributions'](record, rootEl)
       fieldChanged('lineage') && this.writers['lineage'](record, rootEl)

package/src/libs/api/metadata-converter/src/lib/iso19139/read-parts.ts

@@ -14,18 +14,7 @@ import {
   UpdateFrequency,
   UpdateFrequencyCustom,
 } from '../../../../../../libs/common/domain/src/lib/model/record'
-import { getStatusFromStatusCode } from './utils/status.mapper'
-import { getUpdateFrequencyFromFrequencyCode } from './utils/update-frequency.mapper'
-import {
-  findChildElement,
-  findChildrenElement,
-  findNestedElement,
-  findNestedElements,
-  findParent,
-  readAttribute,
-  readText,
-  XmlElement,
-} from '../xml-utils'
+import { matchMimeType, matchProtocol } from '../common/distribution.mapper'
 import {
   ChainableFunction,
   combine,
@@ -37,10 +26,21 @@ import {
   mapArray,
   pipe,
 } from '../function-utils'
-import { getRoleFromRoleCode } from './utils/role.mapper'
-import { matchMimeType, matchProtocol } from '../common/distribution.mapper'
-import { getKeywordTypeFromKeywordTypeCode } from './utils/keyword.mapper'
+import {
+  XmlElement,
+  findChildElement,
+  findChildrenElement,
+  findNestedElement,
+  findNestedElements,
+  findParent,
+  readAttribute,
+  readText,
+} from '../xml-utils'
 import { fullNameToParts } from './utils/individual-name'
+import { getKeywordTypeFromKeywordTypeCode } from './utils/keyword.mapper'
+import { getRoleFromRoleCode } from './utils/role.mapper'
+import { getStatusFromStatusCode } from './utils/status.mapper'
+import { getUpdateFrequencyFromFrequencyCode } from './utils/update-frequency.mapper'
 
 export function extractCharacterString(): ChainableFunction<
   XmlElement,
@@ -843,3 +843,55 @@ export function readOnlineResources(
     flattenArray()
   )(rootEl)
 }
+
+export function readTemporalExtents(rootEl: XmlElement) {
+  return pipe(
+    findIdentification(),
+    findNestedElements('gmd:extent', 'gmd:EX_Extent', 'gmd:temporalElement'),
+    mapArray(
+      combine(
+        findNestedElement(
+          'gmd:EX_TemporalExtent',
+          'gmd:extent',
+          'gml:TimePeriod'
+        ),
+        findNestedElement(
+          'gmd:EX_TemporalExtent',
+          'gmd:extent',
+          'gml:TimeInstant'
+        )
+      )
+    ),
+    mapArray(([periodEl, instantEl]) => {
+      if (periodEl) {
+        return pipe(
+          combine(
+            pipe(
+              findChildElement('gml:beginPosition', false),
+              readText(),
+              map((dateStr) => (dateStr ? new Date(dateStr) : null))
+            ),
+            pipe(
+              findChildElement('gml:endPosition', false),
+              readText(),
+              map((dateStr) => (dateStr ? new Date(dateStr) : null))
+            )
+          ),
+          map(([start, end]) => ({
+            start,
+            end,
+          }))
+        )(periodEl)
+      } else {
+        return pipe(
+          findChildElement('gml:timePosition', false),
+          readText(),
+          map((dateStr) => (dateStr ? new Date(dateStr) : null)),
+          map((date) => ({
+            start: date,
+          }))
+        )(instantEl)
+      }
+    })
+  )(rootEl)
+}

package/src/libs/api/metadata-converter/src/lib/iso19139/write-parts.ts

@@ -15,7 +15,20 @@ import {
   UpdateFrequencyCode,
   UpdateFrequencyCustom,
 } from '../../../../../../libs/common/domain/src/lib/model/record'
+import format from 'date-fns/format'
+import {
+  ChainableFunction,
+  fallback,
+  filterArray,
+  getAtIndex,
+  map,
+  mapArray,
+  noop,
+  pipe,
+  tap,
+} from '../function-utils'
 import {
+  XmlElement,
   addAttribute,
   appendChildren,
   createChild,
@@ -30,20 +43,7 @@ import {
   removeChildren,
   removeChildrenByName,
   setTextContent,
-  XmlElement,
 } from '../xml-utils'
-import {
-  ChainableFunction,
-  fallback,
-  filterArray,
-  getAtIndex,
-  map,
-  mapArray,
-  noop,
-  pipe,
-  tap,
-} from '../function-utils'
-import format from 'date-fns/format'
 import { readKind } from './read-parts'
 import { namePartsToFull } from './utils/individual-name'
 
@@ -1126,3 +1126,61 @@ export function writeOnlineResources(
     appendChildren(...record.onlineResources.map(createOnlineResource))
   )(rootEl)
 }
+
+export function writeTemporalExtents(
+  record: DatasetRecord,
+  rootEl: XmlElement
+) {
+  pipe(
+    findOrCreateIdentification(),
+    findNestedChildOrCreate('gmd:extent', 'gmd:EX_Extent'),
+    removeChildrenByName('gmd:temporalElement'),
+    appendChildren(
+      ...record.temporalExtents.map((extent) =>
+        pipe(
+          createElement('gmd:temporalElement'),
+          createChild('gmd:EX_TemporalExtent'),
+          appendChildren(
+            'start' in extent && 'end' in extent
+              ? pipe(
+                  createElement('gmd:extent'),
+                  createChild('gml:TimePeriod'),
+                  appendChildren(
+                    pipe(
+                      createElement('gml:beginPosition'),
+                      pipe(
+                        extent.start
+                          ? setTextContent(format(extent.start, 'yyyy-MM-dd'))
+                          : addAttribute('indeterminatePosition', 'unknown')
+                      )
+                    ),
+                    pipe(
+                      createElement('gml:endPosition'),
+                      pipe(
+                        extent.end
+                          ? setTextContent(format(extent.end, 'yyyy-MM-dd'))
+                          : addAttribute('indeterminatePosition', 'unknown')
+                      )
+                    )
+                  )
+                )
+              : pipe(
+                  createElement('gmd:extent'),
+                  createChild('gml:TimeInstant'),
+                  appendChildren(
+                    pipe(
+                      createElement('gml:timePosition'),
+                      pipe(
+                        extent.start
+                          ? setTextContent(format(extent.start, 'yyyy-MM-dd'))
+                          : addAttribute('indeterminatePosition', 'unknown')
+                      )
+                    )
+                  )
+                )
+          )
+        )
+      )
+    )
+  )(rootEl)
+}

package/src/libs/api/repository/src/lib/gn4/gn4-repository.ts

@@ -1,7 +1,17 @@
 import { Injectable } from '@angular/core'
-import { SearchApiService } from '../../../../../../libs/data-access/gn4/src'
+import {
+  RecordsApiService,
+  SearchApiService,
+} from '../../../../../../libs/data-access/gn4/src'
 import { ElasticsearchService } from './elasticsearch'
-import { Observable, of, switchMap } from 'rxjs'
+import {
+  combineLatest,
+  from,
+  Observable,
+  of,
+  switchMap,
+  throwError,
+} from 'rxjs'
 import { RecordsRepositoryInterface } from '../../../../../../libs/common/domain/src/lib/repository/records-repository.interface'
 import {
   SearchParams,
@@ -12,19 +22,23 @@ import {
   AggregationsParams,
   FieldFilters,
 } from '../../../../../../libs/common/domain/src/lib/model/search'
-import { map } from 'rxjs/operators'
+import { catchError, map, tap } from 'rxjs/operators'
 import {
+  findConverterForDocument,
   Gn4Converter,
   Gn4SearchResults,
+  Iso19139Converter,
 } from '../../../../../../libs/api/metadata-converter/src'
 import { CatalogRecord } from '../../../../../../libs/common/domain/src/lib/model/record'
+import { HttpErrorResponse } from '@angular/common/http'
 
 @Injectable()
 export class Gn4Repository implements RecordsRepositoryInterface {
   constructor(
     private gn4SearchApi: SearchApiService,
     private gn4SearchHelper: ElasticsearchService,
-    private gn4Mapper: Gn4Converter
+    private gn4Mapper: Gn4Converter,
+    private gn4RecordsApi: RecordsApiService
   ) {}
 
   search({
@@ -84,9 +98,7 @@ export class Gn4Repository implements RecordsRepositoryInterface {
       .pipe(map((results: Gn4SearchResults) => results.hits.total?.value || 0))
   }
 
-  getByUniqueIdentifier(
-    uniqueIdentifier: string
-  ): Observable<CatalogRecord | null> {
+  getRecord(uniqueIdentifier: string): Observable<CatalogRecord | null> {
     return this.gn4SearchApi
       .search(
         'bucket',
@@ -165,4 +177,130 @@ export class Gn4Repository implements RecordsRepositoryInterface {
         )
       )
   }
+
+  /**
+   * Returns null if the record is not found
+   */
+  private loadRecordAsXml(uniqueIdentifier: string): Observable<string | null> {
+    return this.gn4RecordsApi
+      .getRecordAs(
+        uniqueIdentifier,
+        undefined,
+        false,
+        undefined,
+        undefined,
+        undefined,
+        'application/xml',
+        'response',
+        undefined,
+        { httpHeaderAccept: 'text/xml,application/xml' as 'application/xml' } // this is to make sure that the response is parsed as text
+      )
+      .pipe(
+        map((response) => response.body),
+        catchError((error: HttpErrorResponse) =>
+          error.status === 404 ? of(null) : throwError(() => error)
+        )
+      )
+  }
+
+  private getLocalStorageKeyForRecord(uniqueIdentifier: string) {
+    return `geonetwork-ui-draft-${uniqueIdentifier}`
+  }
+
+  openRecordForEdition(
+    uniqueIdentifier: string
+  ): Observable<[CatalogRecord, string, boolean] | null> {
+    const draft$ = of(
+      window.localStorage.getItem(
+        this.getLocalStorageKeyForRecord(uniqueIdentifier)
+      )
+    )
+    const recordAsXml$ = this.loadRecordAsXml(uniqueIdentifier)
+    return combineLatest([draft$, recordAsXml$]).pipe(
+      switchMap(([draft, recordAsXml]) => {
+        const xml = draft ?? recordAsXml
+        const isSavedAlready = recordAsXml !== null
+        return findConverterForDocument(xml)
+          .readRecord(xml)
+          .then(
+            (record) =>
+              [record, xml, isSavedAlready] as [CatalogRecord, string, boolean]
+          )
+      })
+    )
+  }
+
+  private serializeRecordToXml(
+    record: CatalogRecord,
+    referenceRecordSource?: string
+  ): Observable<string> {
+    // if there's a reference record, use that standard; otherwise, use iso19139
+    const converter = referenceRecordSource
+      ? findConverterForDocument(referenceRecordSource)
+      : new Iso19139Converter()
+    return from(converter.writeRecord(record, referenceRecordSource))
+  }
+
+  saveRecord(
+    record: CatalogRecord,
+    referenceRecordSource?: string
+  ): Observable<string> {
+    return this.serializeRecordToXml(record, referenceRecordSource).pipe(
+      switchMap((recordXml) =>
+        this.gn4RecordsApi
+          .insert(
+            'METADATA',
+            undefined,
+            undefined,
+            undefined,
+            true,
+            undefined,
+            'OVERWRITE',
+            undefined,
+            undefined,
+            undefined,
+            '_none_',
+            undefined,
+            undefined,
+            undefined,
+            recordXml
+          )
+          .pipe(map(() => recordXml))
+      ),
+      tap(() => {
+        // if saving was successful, the associated draft can be discarded
+        window.localStorage.removeItem(
+          this.getLocalStorageKeyForRecord(record.uniqueIdentifier)
+        )
+      })
+    )
+  }
+
+  saveRecordAsDraft(
+    record: CatalogRecord,
+    referenceRecordSource?: string
+  ): Observable<string> {
+    return this.serializeRecordToXml(record, referenceRecordSource).pipe(
+      tap((recordXml) =>
+        window.localStorage.setItem(
+          this.getLocalStorageKeyForRecord(record.uniqueIdentifier),
+          recordXml
+        )
+      )
+    )
+  }
+
+  clearRecordDraft(uniqueIdentifier: string): void {
+    window.localStorage.removeItem(
+      this.getLocalStorageKeyForRecord(uniqueIdentifier)
+    )
+  }
+
+  recordHasDraft(uniqueIdentifier: string): boolean {
+    return (
+      window.localStorage.getItem(
+        this.getLocalStorageKeyForRecord(uniqueIdentifier)
+      ) !== null
+    )
+  }
 }

package/src/libs/common/domain/src/lib/model/record/metadata.model.ts

@@ -169,12 +169,12 @@ export interface DatasetSpatialExtent {
 }
 
 /**
- * At least a start or an end date should be provided
+ * Period if both start and end are provided
+ * Instant if only start is provided
  */
 export interface DatasetTemporalExtent {
-  start?: Date
+  start: Date
   end?: Date
-  description?: string
 }
 
 export interface DatasetRecord extends BaseRecord {

package/src/libs/common/domain/src/lib/repository/records-repository.interface.ts

@@ -11,12 +11,45 @@ import { CatalogRecord } from '../model/record'
 export abstract class RecordsRepositoryInterface {
   abstract search(params: SearchParams): Observable<SearchResults>
   abstract getMatchesCount(filters: FieldFilters): Observable<number>
-  abstract getByUniqueIdentifier(
-    uniqueIdentifier: string
-  ): Observable<CatalogRecord | null>
+  abstract getRecord(uniqueIdentifier: string): Observable<CatalogRecord | null>
   abstract aggregate(params: AggregationsParams): Observable<Aggregations>
   abstract getSimilarRecords(
     similarTo: CatalogRecord
   ): Observable<CatalogRecord[]>
   abstract fuzzySearch(query: string): Observable<SearchResults>
+
+  /**
+   * This emits once:
+   * - record object; if a draft exists, this will return it
+   * - serialized representation of the record as text
+   * - boolean indicating if the record has been saved at least once in a final version (i.e. not only as draft)
+   * @param uniqueIdentifier
+   * @returns Observable<[CatalogRecord, string, boolean] | null>
+   */
+  abstract openRecordForEdition(
+    uniqueIdentifier: string
+  ): Observable<[CatalogRecord, string, boolean] | null>
+
+  /**
+   * @param record
+   * @param referenceRecordSource
+   * @returns Observable<string> Returns the source of the record as it was serialized when saved
+   */
+  abstract saveRecord(
+    record: CatalogRecord,
+    referenceRecordSource?: string
+  ): Observable<string>
+
+  /**
+   * @param record
+   * @param referenceRecordSource
+   * @returns Observable<string> Returns the source of the record as it was serialized when saved
+   */
+  abstract saveRecordAsDraft(
+    record: CatalogRecord,
+    referenceRecordSource?: string
+  ): Observable<string>
+
+  abstract clearRecordDraft(uniqueIdentifier: string): void
+  abstract recordHasDraft(uniqueIdentifier: string): boolean
 }