geonetwork-ui 2.3.2 → 2.4.0-alpha.1

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

@@ -1,24 +1,35 @@
 import { Injectable } from '@angular/core'
-import { Observable, of, switchMap } from 'rxjs'
-import { catchError, map, shareReplay, tap } from 'rxjs/operators'
+import { combineLatest, Observable, of, switchMap, throwError } from 'rxjs'
+import { catchError, filter, map, shareReplay, tap } from 'rxjs/operators'
 import {
   MeApiService,
+  RecordsApiService,
   RegistriesApiService,
   SiteApiService,
   ToolsApiService,
   UserfeedbackApiService,
   UsersApiService,
 } from '../../../../../../../libs/data-access/gn4/src'
-import { PlatformServiceInterface } from '../../../../../../../libs/common/domain/src/lib/platform.service.interface'
+import {
+  PlatformServiceInterface,
+  UploadEvent,
+} 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, HttpEventType } from '@angular/common/http'
+import {
+  KeywordApiResponse,
+  ThesaurusApiResponse,
+} from '../../../../../../../libs/api/metadata-converter/src'
+import { KeywordType } from '../../../../../../../libs/common/domain/src/lib/model/thesaurus'
+import { noDuplicateFileName } from '../../../../../../../libs/util/shared/src'
 
 const minApiVersion = '4.2.2'
 
@@ -60,7 +71,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 +81,9 @@ export class Gn4PlatformService implements PlatformServiceInterface {
     private toolsApiService: ToolsApiService,
     private registriesApiService: RegistriesApiService,
     private langService: LangService,
-    private userfeedbackApiService: UserfeedbackApiService
+    private userfeedbackApiService: UserfeedbackApiService,
+    private httpClient: HttpClient,
+    private recordsApiService: RecordsApiService
   ) {
     this.me$ = this.meApi.getMe().pipe(
       switchMap((apiUser) => this.mapper.userFromMeApi(apiUser)),
@@ -121,7 +134,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,32 +146,116 @@ 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]
-    }
-    this.thesauri[uri] = this.registriesApiService
-      .searchKeywords(
-        null,
-        this.langService.iso3,
-        1000,
-        0,
-        null,
-        null,
-        null,
-        `${uri}*`
-      )
-      .pipe(
-        map((thesaurus) =>
-          this.mapper.thesaurusFromApi(
-            thesaurus as any[],
-            this.langService.iso3
+  private allThesaurus$ = this.httpClient
+    .get(
+      `${this.registriesApiService.configuration.basePath}/thesaurus?_content_type=json`
+    )
+    .pipe(
+      map((thesaurus) => {
+        return thesaurus[0] as ThesaurusApiResponse[]
+      }),
+      shareReplay(1)
+    )
+
+  searchKeywords(
+    query: string,
+    keywordTypes: KeywordType[]
+  ): Observable<Keyword[]> {
+    const keywords$: Observable<KeywordApiResponse[]> = this.allThesaurus$.pipe(
+      switchMap((thesaurus) => {
+        const selectedThesauri = []
+        keywordTypes.map((keywordType) => {
+          selectedThesauri.push(
+            ...thesaurus.filter((thes) => thes.dname === keywordType)
           )
-        ),
-        shareReplay(1)
-      )
+        })
+
+        return this.registriesApiService.searchKeywords(
+          query,
+          this.langService.iso3,
+          10,
+          0,
+          null,
+          selectedThesauri.map((thes) => thes.key),
+          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]
+    }
+    const keywords$ = this.registriesApiService.searchKeywords(
+      null,
+      this.langService.iso3,
+      1000,
+      0,
+      null,
+      null,
+      null,
+      `${uri}*`
+    ) 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]
+  }
+
+  searchKeywordsInThesaurus(query: string, thesaurusId: string) {
+    return this.allThesaurus$.pipe(
+      switchMap((thesauri) => {
+        const strippedThesaurusId = thesaurusId.replace(
+          'geonetwork.thesaurus.',
+          ''
+        )
+        if (!thesauri.find((thes) => thes.key === strippedThesaurusId))
+          return of([])
+        return this.registriesApiService
+          .searchKeywords(
+            query,
+            this.langService.iso3,
+            100,
+            0,
+            null,
+            [strippedThesaurusId],
+            null
+          )
+          .pipe(
+            map((keywords: KeywordApiResponse[]) =>
+              this.mapper.keywordsFromApi(
+                keywords,
+                thesauri,
+                this.langService.iso3
+              )
+            )
+          )
+      })
+    )
   }
 
   getUserFeedbacks(uuid: string): Observable<UserFeedback[]> {
@@ -183,4 +280,69 @@ export class Gn4PlatformService implements PlatformServiceInterface {
       })
     )
   }
+
+  getRecordAttachments(recordUuid: string) {
+    return this.recordsApiService.getAllResources(recordUuid).pipe(
+      map((resources) =>
+        resources.map((r) => ({
+          url: new URL(r.url),
+          fileName: r.filename,
+        }))
+      )
+    )
+  }
+
+  attachFileToRecord(recordUuid: string, file: File): Observable<UploadEvent> {
+    let sizeBytes = -1
+
+    // Check if the resource already exists on the server and rename it if that's the case
+    return this.getRecordAttachments(recordUuid).pipe(
+      map((recordAttachement) => recordAttachement.map((r) => r.fileName)),
+      switchMap((fileNames) => {
+        const fileName = noDuplicateFileName(file.name, fileNames)
+
+        const fileCopy = new File([file], fileName, { type: file.type })
+
+        return this.recordsApiService
+          .putResource(
+            recordUuid,
+            fileCopy,
+            'public',
+            undefined,
+            'events',
+            true
+          )
+          .pipe(
+            map((event) => {
+              if (event.type === HttpEventType.UploadProgress) {
+                sizeBytes = event.total
+                return {
+                  type: 'progress',
+                  progress: event.total
+                    ? Math.round((100 * event.loaded) / event.total)
+                    : 0,
+                } as UploadEvent
+              }
+              if (event.type === HttpEventType.Response) {
+                return {
+                  type: 'success',
+                  attachment: {
+                    url: new URL(event.body.url),
+                    fileName: event.body.filename,
+                  },
+                  sizeBytes,
+                } as UploadEvent
+              }
+              return undefined
+            }),
+            filter((event) => !!event)
+          )
+      }),
+      catchError((error) => {
+        return throwError(
+          () => new Error(error.error?.message ?? error.message)
+        )
+      })
+    )
+  }
 }

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

@@ -1,4 +1,5 @@
 import { Organization } from './organization.model'
+import { marker } from '@biesbjerg/ngx-translate-extract-marker'
 
 export const RoleValues = [
   'unspecified',
@@ -24,6 +25,33 @@ export const RoleValues = [
   'user', // Party who uses the resource
 ]
 
+export const RoleLabels = new Map<Role, string>([
+  ['unspecified', marker('domain.contact.role.unspecified')],
+  ['other', marker('domain.contact.role.other')],
+  ['author', marker('domain.contact.role.author')],
+  ['collaborator', marker('domain.contact.role.collaborator')],
+  ['contributor', marker('domain.contact.role.contributor')],
+  ['custodian', marker('domain.contact.role.custodian')],
+  ['distributor', marker('domain.contact.role.distributor')],
+  ['editor', marker('domain.contact.role.editor')],
+  ['funder', marker('domain.contact.role.funder')],
+  ['mediator', marker('domain.contact.role.mediator')],
+  ['originator', marker('domain.contact.role.originator')],
+  ['owner', marker('domain.contact.role.owner')],
+  ['point_of_contact', marker('domain.contact.role.point_of_contact')],
+  [
+    'principal_investigator',
+    marker('domain.contact.role.principal_investigator'),
+  ],
+  ['processor', marker('domain.contact.role.processor')],
+  ['publisher', marker('domain.contact.role.publisher')],
+  ['resource_provider', marker('domain.contact.role.resource_provider')],
+  ['rights_holder', marker('domain.contact.role.rights_holder')],
+  ['sponsor', marker('domain.contact.role.sponsor')],
+  ['stakeholder', marker('domain.contact.role.stakeholder')],
+  ['user', marker('domain.contact.role.user')],
+])
+
 export type Role = typeof RoleValues[number]
 
 export interface Individual {
@@ -32,7 +60,7 @@ export interface Individual {
   email: string
   role: Role
   position?: string
-  organization: Organization
+  organization?: Organization
   address?: string
   phone?: string
 }

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,13 @@ 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
+  bbox?: [number, number, number, number]
 }
 // languages should be expressed using two-letters ISO 639-1 codes
 export type LanguageCode = string
@@ -119,7 +115,7 @@ export type ServiceProtocol =
   | 'ogcFeatures'
   | 'other'
 
-export type DatasetDistributionType = 'service' | 'download' | 'link'
+export type OnlineResourceType = 'service' | 'download' | 'link' | 'endpoint'
 
 export interface DatasetServiceDistribution {
   type: 'service'
@@ -150,12 +146,12 @@ export interface OnlineLinkResource {
   description?: string
 }
 
-export type DatasetDistribution = (
+export type DatasetOnlineResource = (
   | DatasetServiceDistribution
   | DatasetDownloadDistribution
   | OnlineLinkResource
 ) & {
-  type: DatasetDistributionType
+  type: OnlineResourceType
 }
 
 export interface GraphicOverview {
@@ -164,7 +160,8 @@ export interface GraphicOverview {
 }
 
 export interface DatasetSpatialExtent {
-  geometry: Geometry
+  bbox?: [number, number, number, number]
+  geometry?: Geometry
   description?: string
 }
 
@@ -181,14 +178,12 @@ export interface DatasetRecord extends BaseRecord {
   kind: 'dataset'
   status: RecordStatus
   lineage: string // Explanation of the origin of this record (e.g: how, why)"
-  distributions: Array<DatasetDistribution>
+  onlineResources: Array<DatasetOnlineResource>
   spatialExtents: Array<DatasetSpatialExtent>
   temporalExtents: Array<DatasetTemporalExtent>
   spatialRepresentation?: SpatialRepresentationType
 }
 
-export type ServiceOnlineResourceType = 'endpoint' | 'link'
-
 export interface ServiceEndpoint {
   endpointUrl: URL
   protocol: string
@@ -197,7 +192,7 @@ export interface ServiceEndpoint {
 }
 
 export type ServiceOnlineResource = (ServiceEndpoint | OnlineLinkResource) & {
-  type: ServiceOnlineResourceType
+  type: OnlineResourceType
 }
 
 export interface ServiceRecord extends BaseRecord {
@@ -205,6 +200,8 @@ export interface ServiceRecord extends BaseRecord {
   onlineResources: Array<ServiceOnlineResource>
 }
 
+export type OnlineResource = DatasetOnlineResource | ServiceOnlineResource
+
 export type CatalogRecord = ServiceRecord | DatasetRecord
 
 export type CatalogRecordKeys = keyof ServiceRecord | keyof DatasetRecord

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

@@ -1,5 +1,6 @@
 export interface Organization {
   name: string
+  email?: string
   description?: string
   website?: URL
   logoUrl?: URL

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/model/user/user.model.ts

@@ -5,6 +5,6 @@ export interface UserModel {
   name: string
   surname: string
   email: string
-  organisation: string
+  organisation?: string
   profileIcon?: string
 }

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

@@ -1,8 +1,23 @@
 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'
+import { KeywordType } from './model/thesaurus'
+
+export interface RecordAttachment {
+  url: URL
+  fileName: string
+}
+export type UploadEvent =
+  | {
+      type: 'progress'
+      progress: number // in percent
+    }
+  | {
+      type: 'success'
+      attachment: RecordAttachment
+      sizeBytes: number
+    }
 
 export abstract class PlatformServiceInterface {
   abstract getType(): string
@@ -15,8 +30,27 @@ export abstract class PlatformServiceInterface {
     organisation: Organization
   ): Observable<UserModel[]>
   abstract getOrganizations(): Observable<Organization[]>
+
   abstract translateKey(key: string): Observable<string>
-  abstract getThesaurusByUri(uri: string): Observable<ThesaurusModel>
+
+  abstract searchKeywords(
+    query: string,
+    keywordTypes: KeywordType[]
+  ): Observable<Keyword[]>
+  abstract getKeywordsByUri(uri: string): Observable<Keyword[]>
+  abstract searchKeywordsInThesaurus(
+    query: string,
+    thesaurusId: string
+  ): Observable<Keyword[]>
+
   abstract getUserFeedbacks(recordUuid: string): Observable<UserFeedback[]>
   abstract postUserFeedbacks(recordUuid: UserFeedback): Observable<void>
+
+  abstract getRecordAttachments(
+    recordUuid: string
+  ): Observable<RecordAttachment[]>
+  abstract attachFileToRecord(
+    recordUuid: string,
+    file: File
+  ): Observable<UploadEvent>
 }

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

@@ -11,12 +11,81 @@ 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>
+
+  /**
+   * This emits once:
+   * - record object with a new unique identifier and suffixed title
+   * - serialized representation of the record as text
+   * - false, as the duplicated record is always a draft
+   * @param uniqueIdentifier
+   * @returns Observable<[CatalogRecord, string, false] | null>
+   */
+  abstract openRecordForDuplication(
+    uniqueIdentifier: string
+  ): Observable<[CatalogRecord, string, false] | 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>
+
+  /**
+   * Try to duplicate the external record from given url. If it suceed, then it will save the record as draft and return its temporary id.
+   *
+   * @param recordDownloadUrl
+   * @returns Observable<string>
+   */
+  abstract duplicateExternalRecord(
+    recordDownloadUrl: string
+  ): Observable<string>
+
+  /**
+   * @param uniqueIdentifier
+   * @returns Observable<void> Returns when record is deleted
+   */
+  abstract deleteRecord(uniqueIdentifier: string): Observable<void>
+
+  abstract generateTemporaryId(): 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
+  abstract isRecordNotYetSaved(uniqueIdentifier: string): boolean
+
+  /** will return all pending drafts, both published and not published */
+  abstract getAllDrafts(): Observable<CatalogRecord[]>
+  abstract getDraftsCount(): Observable<number>
+  abstract draftsChanged$: Observable<void>
 }

package/src/libs/common/fixtures/src/index.ts

@@ -4,10 +4,15 @@ export * from './lib/search'
 
 export * from './lib/geojson.fixtures'
 export * from './lib/link.fixtures'
-export * from './lib/ol-feature.fixture'
+export * from './lib/ol-feature.fixtures'
 export * from './lib/organisations.fixture'
 export * from './lib/record-link.fixtures'
 export * from './lib/records.fixtures'
 export * from './lib/repository.fixtures'
 export * from './lib/user.fixtures'
+export * from './lib/individual.fixtures'
 export * from './lib/user-feedbacks.fixtures'
+
+export * from './lib/editor'
+
+export * from './lib/map'