geonetwork-ui 2.4.0-dev.fe59f179 → 2.4.1-dev.73bac9979

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

@@ -1,17 +1,28 @@
 import { Injectable } from '@angular/core'
-import { Observable, combineLatest, of, switchMap } from 'rxjs'
-import { catchError, map, shareReplay, tap } from 'rxjs/operators'
+import {
+  catchError,
+  filter,
+  map,
+  mergeMap,
+  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 {
+  CatalogRecord,
   Keyword,
   Organization,
   UserFeedback,
@@ -19,12 +30,21 @@ import {
 import { Gn4PlatformMapper } from './gn4-platform.mapper'
 import { ltr } from 'semver'
 import { LangService } from '../../../../../../../libs/util/i18n/src'
-import { HttpClient } from '@angular/common/http'
+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'
+import {
+  combineLatest,
+  forkJoin,
+  Observable,
+  of,
+  switchMap,
+  throwError,
+} from 'rxjs'
 
 const minApiVersion = '4.2.2'
 
@@ -77,7 +97,8 @@ export class Gn4PlatformService implements PlatformServiceInterface {
     private registriesApiService: RegistriesApiService,
     private langService: LangService,
     private userfeedbackApiService: UserfeedbackApiService,
-    private httpClient: HttpClient
+    private httpClient: HttpClient,
+    private recordsApiService: RecordsApiService
   ) {
     this.me$ = this.meApi.getMe().pipe(
       switchMap((apiUser) => this.mapper.userFromMeApi(apiUser)),
@@ -192,17 +213,16 @@ export class Gn4PlatformService implements PlatformServiceInterface {
     if (this.keywordsByThesauri[uri]) {
       return this.keywordsByThesauri[uri]
     }
-    const keywords$: Observable<KeywordApiResponse[]> =
-      this.registriesApiService.searchKeywords(
-        null,
-        this.langService.iso3,
-        1000,
-        0,
-        null,
-        null,
-        null,
-        `${uri}*`
-      ) as Observable<KeywordApiResponse[]>
+    const keywords$ = this.registriesApiService.searchKeywords(
+      null,
+      this.langService.iso3,
+      1000,
+      0,
+      null,
+      null,
+      null,
+      `${uri}*`
+    ) as Observable<KeywordApiResponse[]>
 
     this.keywordsByThesauri[uri] = combineLatest([
       keywords$,
@@ -221,6 +241,38 @@ export class Gn4PlatformService implements PlatformServiceInterface {
     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[]> {
     return this.userfeedbackApiService.getUserComments(uuid).pipe(
       map((userFeedbacks) =>
@@ -243,4 +295,109 @@ 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,
+        }))
+      )
+    )
+  }
+
+  cleanRecordAttachments(record: CatalogRecord): Observable<void> {
+    return combineLatest([
+      this.recordsApiService.getAssociatedResources(record.uniqueIdentifier),
+      this.recordsApiService.getAllResources(record.uniqueIdentifier),
+    ]).pipe(
+      map(([associatedResources, recordResources]) => {
+        // Received object from API is not a RelatedResponseApiModel, so we need
+        // to cast it as any and do the bellow mappings to get the wanted values.
+        const resourceIdsToKeep = [
+          ...((associatedResources as any).onlines ?? []).map(
+            (o) => Object.values(o.title)[0]
+          ),
+          ...((associatedResources as any).thumbnails ?? []).map(
+            (o) => Object.values(o.title)[0]
+          ),
+        ]
+
+        const resourceIdsToRemove = recordResources
+          .map((r) => r.filename)
+          .filter((resourceId) => !resourceIdsToKeep.includes(resourceId))
+
+        return resourceIdsToRemove
+      }),
+      mergeMap((resourceIdsToRemove) =>
+        forkJoin(
+          resourceIdsToRemove.map((attachementId) =>
+            this.recordsApiService.delResource(
+              record.uniqueIdentifier,
+              attachementId
+            )
+          )
+        ).pipe(map(() => undefined))
+      ),
+      catchError((error) => {
+        console.error('Error while cleaning attachments:', error)
+        throw error
+      })
+    )
+  }
+
+  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/dataviz/dataviz-configuration.model.ts

@@ -9,7 +9,7 @@ export const CHART_TYPE_VALUES = [
   'pie',
 ] as const
 
-export type InputChartType = typeof CHART_TYPE_VALUES[number]
+export type InputChartType = (typeof CHART_TYPE_VALUES)[number]
 
 export interface DatavizConfigurationModel {
   xProperty: string

package/src/libs/common/domain/src/lib/model/error/index.ts

@@ -0,0 +1 @@
+export * from './publication-version.error'

package/src/libs/common/domain/src/lib/model/error/publication-version.error.ts

@@ -0,0 +1,9 @@
+export class PublicationVersionError extends Error {
+  detectedApiVersion: string
+
+  constructor(detectedApiVersion: string) {
+    super()
+    this.name = 'PublicationVersionError'
+    this.detectedApiVersion = detectedApiVersion
+  }
+}

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,7 +25,34 @@ export const RoleValues = [
   'user', // Party who uses the resource
 ]
 
-export type Role = typeof RoleValues[number]
+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 {
   firstName?: string
@@ -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/index.ts

@@ -2,3 +2,4 @@ export * from './contact.model'
 export * from './organization.model'
 export * from './metadata.model'
 export * from './user-feedbacks.model'
+export * from './translation.model'

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

@@ -3,6 +3,14 @@ import type { Individual } from './contact.model'
 import type { Organization } from './organization.model'
 import type { Geometry } from 'geojson'
 import { KeywordType, ThesaurusModel } from '../thesaurus'
+import {
+  ConstraintTranslations,
+  KeywordTranslations,
+  LanguageCode,
+  OnlineResourceTranslations,
+  RecordTranslations,
+  SpatialExtentTranslations,
+} from './translation.model'
 
 type Uuid = string
 
@@ -13,26 +21,48 @@ marker('domain.record.updateFrequency.irregular')
 marker('domain.record.updateFrequency.continual')
 marker('domain.record.updateFrequency.periodic')
 
-export type UpdateFrequencyCode =
-  | 'unknown'
-  | 'notPlanned'
-  | 'asNeeded'
-  | 'irregular'
-  | 'continual'
-  | 'periodic'
+export const updateFrequencyCodeValues = [
+  'unknown',
+  'notPlanned',
+  'asNeeded',
+  'irregular',
+  'continual',
+  'periodic',
+  'daily',
+  'weekly',
+  'fortnightly',
+  'semimonthly',
+  'monthly',
+  'quarterly',
+  'biannually',
+  'annually',
+  'biennially',
+] as const
+
+export type UpdateFrequencyCode = (typeof updateFrequencyCodeValues)[number]
 
 marker('domain.record.updateFrequency.day')
 marker('domain.record.updateFrequency.week')
 marker('domain.record.updateFrequency.month')
 marker('domain.record.updateFrequency.year')
 
+marker('domain.record.updateFrequency.daily')
+marker('domain.record.updateFrequency.weekly')
+marker('domain.record.updateFrequency.fortnightly')
+marker('domain.record.updateFrequency.monthly')
+marker('domain.record.updateFrequency.quarterly')
+marker('domain.record.updateFrequency.biannually')
+marker('domain.record.updateFrequency.annually')
+marker('domain.record.updateFrequency.semimonthly')
+marker('domain.record.updateFrequency.biennially')
+
 export type UpdateFrequencyCustom = {
   updatedTimes: number // this should be an integer
   per: 'day' | 'week' | 'month' | 'year'
 }
 export type UpdateFrequency = UpdateFrequencyCode | UpdateFrequencyCustom
 
-export type RecordKind = 'dataset' | 'service'
+export type RecordKind = 'dataset' | 'service' | 'reuse'
 
 marker('domain.record.status.completed')
 marker('domain.record.status.ongoing')
@@ -47,11 +77,13 @@ export const RecordStatusValues = [
   'deprecated',
   'removed',
 ]
-export type RecordStatus = typeof RecordStatusValues[number]
+export type RecordStatus = (typeof RecordStatusValues)[number]
 
 export type Constraint = {
   text: string
   url?: URL
+
+  translations?: ConstraintTranslations
 }
 
 export type SpatialRepresentationType =
@@ -67,9 +99,10 @@ export interface Keyword {
   description?: string
   type: KeywordType
   thesaurus?: ThesaurusModel
+  bbox?: [number, number, number, number]
+
+  translations?: KeywordTranslations
 }
-// languages should be expressed using two-letters ISO 639-1 codes
-export type LanguageCode = string
 
 export interface BaseRecord {
   uniqueIdentifier: Uuid
@@ -80,7 +113,6 @@ export interface BaseRecord {
   recordCreated?: Date
   recordPublished?: Date
   recordUpdated: Date
-  languages: Array<LanguageCode>
   kind: RecordKind
   topics: Array<string> // TODO: handle codelists
   keywords: Array<Keyword>
@@ -94,11 +126,18 @@ export interface BaseRecord {
   updateFrequency?: UpdateFrequency
 
   // information related to the resource (dataset, service)
+  resourceIdentifier?: string
   contactsForResource: Array<Individual>
   resourceCreated?: Date
   resourcePublished?: Date
   resourceUpdated?: Date
 
+  // multilingual support
+  defaultLanguage: LanguageCode
+  otherLanguages: Array<LanguageCode> // this should include all non-default languages present in the metadata, even if incompletely translated
+
+  translations?: RecordTranslations
+
   // to add: canonical url
   // to add: source catalog (??)
   // to add: is open data ?
@@ -112,9 +151,10 @@ export type ServiceProtocol =
   | 'wmts'
   | 'esriRest'
   | 'ogcFeatures'
+  | 'GPFDL'
   | 'other'
 
-export type DatasetDistributionType = 'service' | 'download' | 'link'
+export type OnlineResourceType = 'service' | 'download' | 'link' | 'endpoint'
 
 export interface DatasetServiceDistribution {
   type: 'service'
@@ -123,6 +163,7 @@ export interface DatasetServiceDistribution {
   identifierInService?: string
   name?: string
   description?: string
+  translations?: OnlineResourceTranslations
 }
 
 export interface DatasetDownloadDistribution {
@@ -136,6 +177,7 @@ export interface DatasetDownloadDistribution {
   name?: string
   description?: string
   accessServiceProtocol?: ServiceProtocol
+  translations?: OnlineResourceTranslations
 }
 
 export interface OnlineLinkResource {
@@ -143,14 +185,15 @@ export interface OnlineLinkResource {
   url: URL
   name?: string
   description?: string
+  translations?: OnlineResourceTranslations
 }
 
-export type DatasetDistribution = (
+export type DatasetOnlineResource = (
   | DatasetServiceDistribution
   | DatasetDownloadDistribution
   | OnlineLinkResource
 ) & {
-  type: DatasetDistributionType
+  type: OnlineResourceType
 }
 
 export interface GraphicOverview {
@@ -159,8 +202,10 @@ export interface GraphicOverview {
 }
 
 export interface DatasetSpatialExtent {
-  geometry: Geometry
+  bbox?: [number, number, number, number]
+  geometry?: Geometry
   description?: string
+  translations?: SpatialExtentTranslations
 }
 
 /**
@@ -176,30 +221,46 @@ 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
   type: 'endpoint'
   description?: string
+  translations?: OnlineResourceTranslations
 }
 
 export type ServiceOnlineResource = (ServiceEndpoint | OnlineLinkResource) & {
-  type: ServiceOnlineResourceType
+  type: OnlineResourceType
 }
 
 export interface ServiceRecord extends BaseRecord {
   kind: 'service'
   onlineResources: Array<ServiceOnlineResource>
+  spatialExtents: Array<DatasetSpatialExtent>
 }
 
-export type CatalogRecord = ServiceRecord | DatasetRecord
+export interface ReuseRecord extends BaseRecord {
+  kind: 'reuse'
+  lineage: string // Explanation of the origin of this record (e.g: how, why)"
+  onlineResources: Array<OnlineLinkResource>
+  reuseType: ReuseType
+  spatialExtents: Array<DatasetSpatialExtent>
+  temporalExtents: Array<DatasetTemporalExtent>
+}
+
+export type ReuseType = 'application' | 'map' | 'other'
+
+export type OnlineResource = DatasetOnlineResource | ServiceOnlineResource
+
+export type CatalogRecord = DatasetRecord | ReuseRecord | ServiceRecord
 
-export type CatalogRecordKeys = keyof ServiceRecord | keyof DatasetRecord
+export type CatalogRecordKeys =
+  | keyof DatasetRecord
+  | keyof ReuseRecord
+  | keyof ServiceRecord

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

@@ -1,3 +1,5 @@
+import { OrganizationTranslations } from './translation.model'
+
 export interface Organization {
   name: string
   email?: string
@@ -5,4 +7,6 @@ export interface Organization {
   website?: URL
   logoUrl?: URL
   recordCount?: number
+
+  translations?: OrganizationTranslations
 }

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

@@ -0,0 +1,49 @@
+// languages should be expressed using two-letters ISO 639-1 codes
+export type LanguageCode = string
+
+// Translations are organized like so (assuming `en` is the default language of the record):
+// {
+//   "Text in English": {
+//     "fr": "Texte en français",
+//     "it": "Testo in italiano",
+//     "de": "Text auf Deutsch",
+//   },
+//   ...
+// }
+export type FieldTranslation = Record<LanguageCode, string>
+
+export interface RecordTranslations {
+  title?: FieldTranslation
+  abstract?: FieldTranslation
+  lineage?: FieldTranslation
+}
+
+export interface OrganizationTranslations {
+  name?: FieldTranslation
+}
+
+export interface KeywordTranslations {
+  label?: FieldTranslation
+  description?: FieldTranslation
+}
+
+export interface ConstraintTranslations {
+  text?: FieldTranslation
+}
+
+export interface OnlineResourceTranslations {
+  name?: FieldTranslation
+  description?: FieldTranslation
+}
+
+export interface SpatialExtentTranslations {
+  description?: FieldTranslation
+}
+
+export type ModelTranslations =
+  | RecordTranslations
+  | OrganizationTranslations
+  | KeywordTranslations
+  | ConstraintTranslations
+  | OnlineResourceTranslations
+  | SpatialExtentTranslations

package/src/libs/common/domain/src/lib/model/search/filter.model.ts

@@ -2,5 +2,21 @@ import { FieldName } from './field.model'
 
 export type FieldFilterByValues = Record<string, boolean>
 export type FieldFilterByExpression = string | number
-export type FieldFilter = FieldFilterByExpression | FieldFilterByValues
+export type FieldFilterByRange = {
+  start?: Date
+  end?: Date
+}
+
+export type FieldFilter =
+  | FieldFilterByExpression
+  | FieldFilterByValues
+  | FieldFilterByRange
 export type FieldFilters = Record<FieldName, FieldFilter>
+
+export type QueryString = {
+  query_string: string
+}
+export type QueryRange = {
+  range: Record<string, { format: string; gte: string; lte: string }>
+}
+export type FilterQuery = Array<QueryString | QueryRange>

package/src/libs/common/domain/src/lib/model/search/sort-by.model.ts

@@ -5,4 +5,5 @@ export const SortByEnum: Record<string, SortByField> = {
   POPULARITY: ['desc', 'userSavedCount'],
   RELEVANCY: ['desc', '_score'],
   QUALITY_SCORE: ['desc', 'qualityScore'],
+  CHANGE_DATE: ['desc', 'changeDate'],
 }

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
 }