geonetwork-ui 2.4.0-dev.a2f3bb9f → 2.4.0-dev.f6f2f023

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,129 @@ 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((response) => {
+              const metadataId = Object.keys(response.metadataInfos)[0]
+              return response.metadataInfos[metadataId][0].uuid
+            })
+          )
+      )
+    )
+  }
+
+  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/api/repository/src/lib/gn4/platform/gn4-platform.mapper.ts

@@ -8,11 +8,16 @@ import { Injectable } from '@angular/core'
 import { AvatarServiceInterface } from '../auth'
 import { map } from 'rxjs/operators'
 import { Observable, of } from 'rxjs'
-import { ThesaurusModel } from '../../../../../../../libs/common/domain/src/lib/model/thesaurus/thesaurus.model'
 import {
+  Keyword,
   UserFeedback,
   UserFeedbackViewModel,
 } from '../../../../../../../libs/common/domain/src/lib/model/record'
+import {
+  KeywordApiResponse,
+  ThesaurusApiResponse,
+} from '../../../../../../../libs/api/metadata-converter/src'
+import { KeywordType } from '../../../../../../../libs/common/domain/src/lib/model/thesaurus'
 
 @Injectable()
 export class Gn4PlatformMapper {
@@ -52,8 +57,12 @@ export class Gn4PlatformMapper {
     return { ...apiUser, id: id.toString() } as UserModel
   }
 
-  thesaurusFromApi(thesaurus: any[], lang3?: string): ThesaurusModel {
-    return thesaurus.map((keyword) => {
+  keywordsFromApi(
+    keywords: KeywordApiResponse[],
+    thesaurus: ThesaurusApiResponse[],
+    lang3?: string
+  ): Keyword[] {
+    return keywords.map((keyword): Keyword => {
       let key = keyword.uri
       // sometines GN can prefix an URI with an "all thesaurus" URI; only keep the last one
       if (key.indexOf('@@@') > -1) {
@@ -65,10 +74,22 @@ export class Gn4PlatformMapper {
         lang3 && lang3 in keyword.definitions
           ? keyword.definitions[lang3]
           : keyword.definition
+
+      const matchedThesaurus = thesaurus.find(
+        (thes) => keyword.thesaurusKey === thes.key
+      )
+
       return {
         key,
         label,
         description,
+        type: matchedThesaurus?.dname as KeywordType,
+        thesaurus: {
+          id: matchedThesaurus?.key,
+          name: matchedThesaurus?.title,
+          url: new URL(matchedThesaurus?.url),
+          type: matchedThesaurus?.dname as KeywordType,
+        },
       }
     })
   }

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

@@ -1,10 +1,11 @@
 import { Injectable } from '@angular/core'
-import { Observable, of, switchMap } from 'rxjs'
+import { Observable, combineLatest, of, switchMap } from 'rxjs'
 import { catchError, map, shareReplay, tap } from 'rxjs/operators'
 import {
   MeApiService,
   RegistriesApiService,
   SiteApiService,
+  ThesaurusInfoApiModel,
   ToolsApiService,
   UserfeedbackApiService,
   UsersApiService,
@@ -12,13 +13,18 @@ import {
 import { PlatformServiceInterface } from '../../../../../../../libs/common/domain/src/lib/platform.service.interface'
 import { UserModel } from '../../../../../../../libs/common/domain/src/lib/model/user/user.model'
 import {
+  Keyword,
   Organization,
   UserFeedback,
 } from '../../../../../../../libs/common/domain/src/lib/model/record'
 import { Gn4PlatformMapper } from './gn4-platform.mapper'
 import { ltr } from 'semver'
-import { ThesaurusModel } from '../../../../../../../libs/common/domain/src/lib/model/thesaurus/thesaurus.model'
 import { LangService } from '../../../../../../../libs/util/i18n/src'
+import { HttpClient } from '@angular/common/http'
+import {
+  KeywordApiResponse,
+  ThesaurusApiResponse,
+} from '../../../../../../../libs/api/metadata-converter/src'
 
 const minApiVersion = '4.2.2'
 
@@ -60,7 +66,7 @@ export class Gn4PlatformService implements PlatformServiceInterface {
    * A map of already loaded thesauri (groups of keywords); the key is a URI
    * @private
    */
-  private thesauri: Record<string, Observable<ThesaurusModel>> = {}
+  private keywordsByThesauri: Record<string, Observable<Keyword[]>> = {}
 
   constructor(
     private siteApiService: SiteApiService,
@@ -70,7 +76,8 @@ export class Gn4PlatformService implements PlatformServiceInterface {
     private toolsApiService: ToolsApiService,
     private registriesApiService: RegistriesApiService,
     private langService: LangService,
-    private userfeedbackApiService: UserfeedbackApiService
+    private userfeedbackApiService: UserfeedbackApiService,
+    private httpClient: HttpClient
   ) {
     this.me$ = this.meApi.getMe().pipe(
       switchMap((apiUser) => this.mapper.userFromMeApi(apiUser)),
@@ -121,7 +128,7 @@ export class Gn4PlatformService implements PlatformServiceInterface {
       // the thesaurus URI is inferred by removing a part of the keyword URI
       // this is not exact science but it's OK, we'll still end up loading a bunch of keywords at once anyway
       const thesaurusUri = key.replace(/\/([^/]+)$/, '/')
-      return this.getThesaurusByUri(thesaurusUri).pipe(
+      return this.getKeywordsByUri(thesaurusUri).pipe(
         map((thesaurus) => {
           for (const item of thesaurus) {
             if (item.key === key) return item.label
@@ -133,12 +140,49 @@ export class Gn4PlatformService implements PlatformServiceInterface {
     return this.keyTranslations$.pipe(map((translations) => translations[key]))
   }
 
-  getThesaurusByUri(uri: string): Observable<ThesaurusModel> {
-    if (this.thesauri[uri]) {
-      return this.thesauri[uri]
+  private allThesaurus$ = this.httpClient
+    .get(
+      `${this.registriesApiService.configuration.basePath}/thesaurus?_content_type=json`
+    )
+    .pipe(
+      map((thesaurus) => {
+        // FIXME: find a better way to exclude place keywords
+        // thesaurus[0].filter((thes) => thes.dname !== 'place')
+        return thesaurus[0] as ThesaurusApiResponse[]
+      }),
+      shareReplay(1)
+    )
+
+  searchKeywords(query: string): Observable<Keyword[]> {
+    const keywords$: Observable<KeywordApiResponse[]> =
+      this.registriesApiService.searchKeywords(
+        query,
+        this.langService.iso3,
+        10,
+        0,
+        null,
+        null,
+        null,
+        `*${query}*`
+      ) as Observable<KeywordApiResponse[]>
+
+    return combineLatest([keywords$, this.allThesaurus$]).pipe(
+      map(([keywords, thesaurus]) => {
+        return this.mapper.keywordsFromApi(
+          keywords,
+          thesaurus,
+          this.langService.iso3
+        )
+      })
+    )
+  }
+
+  getKeywordsByUri(uri: string): Observable<Keyword[]> {
+    if (this.keywordsByThesauri[uri]) {
+      return this.keywordsByThesauri[uri]
     }
-    this.thesauri[uri] = this.registriesApiService
-      .searchKeywords(
+    const keywords$: Observable<KeywordApiResponse[]> =
+      this.registriesApiService.searchKeywords(
         null,
         this.langService.iso3,
         1000,
@@ -147,18 +191,23 @@ export class Gn4PlatformService implements PlatformServiceInterface {
         null,
         null,
         `${uri}*`
-      )
-      .pipe(
-        map((thesaurus) =>
-          this.mapper.thesaurusFromApi(
-            thesaurus as any[],
-            this.langService.iso3
-          )
-        ),
-        shareReplay(1)
-      )
+      ) as Observable<KeywordApiResponse[]>
+
+    this.keywordsByThesauri[uri] = combineLatest([
+      keywords$,
+      this.allThesaurus$,
+    ]).pipe(
+      map(([keywords, thesaurus]) => {
+        return this.mapper.keywordsFromApi(
+          keywords,
+          thesaurus,
+          this.langService.iso3
+        )
+      }),
+      shareReplay(1)
+    )
 
-    return this.thesauri[uri]
+    return this.keywordsByThesauri[uri]
   }
 
   getUserFeedbacks(uuid: string): Observable<UserFeedback[]> {

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

@@ -2,6 +2,7 @@ import { marker } from '@biesbjerg/ngx-translate-extract-marker'
 import type { Individual } from './contact.model'
 import type { Organization } from './organization.model'
 import type { Geometry } from 'geojson'
+import { KeywordType, ThesaurusModel } from '../thesaurus'
 
 type Uuid = string
 
@@ -60,18 +61,12 @@ export type SpatialRepresentationType =
   | 'table'
   | 'point'
 
-export type KeywordType = 'place' | 'temporal' | 'theme' | 'other'
-
-export type KeywordThesaurus = {
-  id: string
-  name?: string
-  url?: URL
-}
-
 export interface Keyword {
+  key?: string
   label: string
+  description?: string
   type: KeywordType
-  thesaurus?: KeywordThesaurus
+  thesaurus?: ThesaurusModel
 }
 // languages should be expressed using two-letters ISO 639-1 codes
 export type LanguageCode = string

package/src/libs/common/domain/src/lib/model/thesaurus/thesaurus.model.ts

@@ -1,7 +1,14 @@
-export interface ThesaurusItemModel {
-  key: string
-  label: string
-  description?: string
-}
+export type KeywordType = 'place' | 'temporal' | 'theme' | 'other'
 
-export type ThesaurusModel = ThesaurusItemModel[]
+export interface ThesaurusModel {
+  id: string
+  name?: string
+  url?: URL
+  thesaurusKey?: string
+  definition?: string
+  definitions?: object
+  uri?: string
+  value?: string
+  values?: object
+  type?: KeywordType
+}

package/src/libs/common/domain/src/lib/platform.service.interface.ts

@@ -1,8 +1,7 @@
 import type { Observable } from 'rxjs'
 import type { UserModel } from './model/user/user.model'
 import type { Organization } from './model/record/organization.model'
-import type { ThesaurusModel } from './model/thesaurus/'
-import { UserFeedback } from './model/record'
+import { Keyword, UserFeedback } from './model/record'
 
 export abstract class PlatformServiceInterface {
   abstract getType(): string
@@ -16,7 +15,8 @@ export abstract class PlatformServiceInterface {
   ): Observable<UserModel[]>
   abstract getOrganizations(): Observable<Organization[]>
   abstract translateKey(key: string): Observable<string>
-  abstract getThesaurusByUri(uri: string): Observable<ThesaurusModel>
+  abstract searchKeywords(query: string): Observable<Keyword[]>
+  abstract getKeywordsByUri(uri: string): Observable<Keyword[]>
   abstract getUserFeedbacks(recordUuid: string): Observable<UserFeedback[]>
   abstract postUserFeedbacks(recordUuid: UserFeedback): Observable<void>
 }

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 unique identifier of the record as it was 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
 }