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

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

@@ -1,7 +1,7 @@
 import {
   CatalogRecord,
   Constraint,
-  DatasetDistribution,
+  DatasetOnlineResource,
   DatasetRecord,
   DatasetServiceDistribution,
   Individual,
@@ -14,12 +14,12 @@ import {
   UpdateFrequencyCode,
   UpdateFrequencyCustom,
 } from '../../../../../../libs/common/domain/src/lib/model/record'
+import { ThesaurusModel } from '../../../../../../libs/common/domain/src/lib/model/thesaurus'
 import format from 'date-fns/format'
+import { Geometry } from 'geojson'
 import {
   ChainableFunction,
-  fallback,
   filterArray,
-  getAtIndex,
   map,
   mapArray,
   noop,
@@ -27,25 +27,25 @@ import {
   tap,
 } from '../function-utils'
 import {
-  XmlElement,
   addAttribute,
   appendChildren,
   createChild,
   createElement,
-  findChildElement,
   findChildOrCreate,
   findChildrenElement,
   findNestedChildOrCreate,
+  findNestedElement,
   findNestedElements,
   readAttribute,
   removeAllChildren,
   removeChildren,
   removeChildrenByName,
   setTextContent,
+  XmlElement,
 } from '../xml-utils'
 import { readKind } from './read-parts'
+import { writeGeometry } from './utils/geometry'
 import { namePartsToFull } from './utils/individual-name'
-import { ThesaurusModel } from '../../../../../../libs/common/domain/src/lib/model/thesaurus'
 
 export function writeCharacterString(
   text: string
@@ -82,11 +82,9 @@ export function writeAnchor(
 export function writeDateTime(
   date: Date
 ): ChainableFunction<XmlElement, XmlElement> {
-  return tap(
-    pipe(
-      findChildOrCreate('gco:DateTime'),
-      setTextContent(format(date, "yyyy-MM-dd'T'HH:mm:ss"))
-    )
+  return pipe(
+    findChildOrCreate('gco:DateTime'),
+    setTextContent(format(date, "yyyy-MM-dd'T'HH:mm:ss"))
   )
 }
 
@@ -101,6 +99,14 @@ export function writeDate(
   )
 }
 
+export function writeDecimal(
+  decimal: number
+): ChainableFunction<XmlElement, XmlElement> {
+  return tap(
+    pipe(findChildOrCreate('gco:Decimal'), setTextContent(decimal.toString()))
+  )
+}
+
 export function getProgressCode(status: RecordStatus): string {
   switch (status) {
     case 'completed':
@@ -169,7 +175,7 @@ export function getRoleCode(role: Role): string {
   }
 }
 
-export function getDistributionProtocol(
+export function getServiceDistributionProtocol(
   distribution: DatasetServiceDistribution
 ): string {
   switch (distribution.accessServiceProtocol.toLowerCase()) {
@@ -232,7 +238,7 @@ export function getISODuration(updateFrequency: UpdateFrequencyCustom): string {
   return `P${duration.years}Y${duration.months}M${duration.days}D${hours}`
 }
 
-export function appendResponsibleParty(contact: Individual) {
+function appendResponsibleParty(contact: Individual) {
   const fullName = namePartsToFull(contact.firstName, contact.lastName)
 
   const createAddress = pipe(
@@ -268,7 +274,7 @@ export function appendResponsibleParty(contact: Individual) {
         )
       : noop,
     appendChildren(createAddress),
-    'website' in contact.organization
+    contact.organization?.website
       ? appendChildren(
           pipe(
             createElement('gmd:onlineResource'),
@@ -298,11 +304,16 @@ export function appendResponsibleParty(contact: Individual) {
             )
           )
         : noop,
+
+      contact.organization?.name
+        ? appendChildren(
+            pipe(
+              createElement('gmd:organisationName'),
+              writeCharacterString(contact.organization.name)
+            )
+          )
+        : noop,
       appendChildren(
-        pipe(
-          createElement('gmd:organisationName'),
-          writeCharacterString(contact.organization.name)
-        ),
         createContact,
         pipe(
           createElement('gmd:role'),
@@ -318,50 +329,6 @@ export function appendResponsibleParty(contact: Individual) {
   )
 }
 
-export function updateCitationDate(
-  date: Date,
-  type: 'revision' | 'creation' | 'publication'
-) {
-  return pipe(
-    findNestedElements('gmd:date', 'gmd:CI_Date'),
-    filterArray(
-      pipe(
-        findChildElement('gmd:CI_DateTypeCode'),
-        readAttribute('codeListValue'),
-        map((value) => value === type)
-      )
-    ),
-    getAtIndex(0),
-    findChildElement('gmd:date'),
-    removeAllChildren(),
-    writeDateTime(date)
-  )
-}
-
-export function appendCitationDate(
-  date: Date,
-  type: 'revision' | 'creation' | 'publication'
-) {
-  return appendChildren(
-    pipe(
-      createElement('gmd:date'),
-      createChild('gmd:CI_Date'),
-      appendChildren(
-        pipe(createElement('gmd:date'), writeDateTime(date)),
-        pipe(
-          createElement('gmd:dateType'),
-          createChild('gmd:CI_DateTypeCode'),
-          addAttribute(
-            'codeList',
-            'http://standards.iso.org/iso/19139/resources/gmxCodelists.xml#CI_DateTypeCode'
-          ),
-          addAttribute('codeListValue', type)
-        )
-      )
-    )
-  )
-}
-
 export function removeKeywords() {
   return removeChildren(pipe(findNestedElements('gmd:descriptiveKeywords')))
 }
@@ -600,11 +567,11 @@ export function createLicense(license: Constraint) {
   )
 }
 
-export function removeDistributions() {
+export function removeOnlineResources() {
   return pipe(removeChildrenByName('gmd:distributionInfo'))
 }
 
-function appendDistributionFormat(mimeType: string) {
+function appendOnlineResourceFormat(mimeType: string) {
   return appendChildren(
     pipe(
       createElement('gmd:distributionFormat'),
@@ -628,8 +595,8 @@ export function createDistributionInfo() {
 }
 
 // apply to MD_Distribution
-export function appendDistribution(
-  distribution: DatasetDistribution,
+export function appendOnlineResource(
+  onlineResource: DatasetOnlineResource,
   appendFormatFn: (
     mimeType: string
   ) => ChainableFunction<XmlElement, XmlElement>
@@ -637,16 +604,16 @@ export function appendDistribution(
   let name: string
   let functionCode: string
   let protocol: string
-  if (distribution.type === 'service') {
-    name = distribution.identifierInService // this is for GeoNetwork to know the layer name
+  if (onlineResource.type === 'service') {
+    name = onlineResource.identifierInService // this is for GeoNetwork to know the layer name
     functionCode = 'download'
-    protocol = getDistributionProtocol(distribution)
-  } else if (distribution.type === 'download') {
-    name = distribution.name
+    protocol = getServiceDistributionProtocol(onlineResource)
+  } else if (onlineResource.type === 'download') {
+    name = onlineResource.name
     functionCode = 'download'
     protocol = 'WWW:DOWNLOAD'
   } else {
-    name = distribution.name
+    name = onlineResource.name
     functionCode = 'information'
     protocol = 'WWW:LINK'
   }
@@ -656,12 +623,12 @@ export function appendDistribution(
       createChild('gmd:MD_DigitalTransferOptions'),
       createChild('gmd:onLine'),
       createChild('gmd:CI_OnlineResource'),
-      writeLinkage(distribution.url),
-      'description' in distribution
+      writeLinkage(onlineResource.url),
+      'description' in onlineResource
         ? appendChildren(
             pipe(
               createElement('gmd:description'),
-              writeCharacterString(distribution.description)
+              writeCharacterString(onlineResource.description)
             )
           )
         : noop,
@@ -685,7 +652,9 @@ export function appendDistribution(
     )
   )
   return pipe(
-    'mimeType' in distribution ? appendFormatFn(distribution.mimeType) : noop,
+    'mimeType' in onlineResource
+      ? appendFormatFn(onlineResource.mimeType)
+      : noop,
     appendTransferOptions
   )
 }
@@ -733,41 +702,6 @@ export function writeKind(record: CatalogRecord, rootEl: XmlElement) {
   )(rootEl)
 }
 
-export function writeOwnerOrganization(
-  record: CatalogRecord,
-  rootEl: XmlElement
-) {
-  // if no contact matches the owner org, create an empty one
-  const ownerContact: Individual = record.contacts.find(
-    (contact) => contact.organization.name === record.ownerOrganization.name
-  )
-  pipe(
-    findChildOrCreate('gmd:contact'),
-    removeAllChildren(),
-    appendResponsibleParty(
-      ownerContact
-        ? {
-            ...ownerContact,
-            // owner responsible party is always point of contact
-            role: 'point_of_contact',
-          }
-        : {
-            organization: record.ownerOrganization,
-            email: '',
-            role: 'point_of_contact',
-          }
-    )
-  )(rootEl)
-}
-
-export function writeRecordUpdated(record: CatalogRecord, rootEl: XmlElement) {
-  pipe(
-    findChildOrCreate('gmd:dateStamp'),
-    removeAllChildren(),
-    writeDateTime(record.recordUpdated)
-  )(rootEl)
-}
-
 export function writeTitle(record: CatalogRecord, rootEl: XmlElement) {
   pipe(
     findOrCreateIdentification(),
@@ -927,49 +861,92 @@ export function writeUpdateFrequency(
   )(rootEl)
 }
 
-export function writeResourceCreated(
-  record: DatasetRecord,
-  rootEl: XmlElement
-) {
-  if (!('resourceCreated' in record)) return
+export function writeRecordUpdated(record: CatalogRecord, rootEl: XmlElement) {
   pipe(
+    findChildOrCreate('gmd:dateStamp'),
+    removeAllChildren(),
+    writeDateTime(record.recordUpdated)
+  )(rootEl)
+}
+
+export function removeResourceDate(
+  type: 'revision' | 'creation' | 'publication'
+) {
+  return pipe(
     findOrCreateIdentification(),
     findNestedChildOrCreate('gmd:citation', 'gmd:CI_Citation'),
-    fallback(
-      updateCitationDate(record.resourceCreated, 'creation'),
-      appendCitationDate(record.resourceCreated, 'creation')
+    removeChildren(
+      pipe(
+        findNestedElements('gmd:date'),
+        filterArray(
+          pipe(
+            findNestedElement(
+              'gmd:CI_Date',
+              'gmd:dateType',
+              'gmd:CI_DateTypeCode'
+            ),
+            readAttribute('codeListValue'),
+            map((value) => value === type)
+          )
+        )
+      )
     )
-  )(rootEl)
+  )
 }
 
-export function writeResourceUpdated(
-  record: DatasetRecord,
-  rootEl: XmlElement
+export function appendResourceDate(
+  date: Date,
+  type: 'revision' | 'creation' | 'publication'
 ) {
-  if (!('resourceUpdated' in record)) return
-  pipe(
+  return pipe(
     findOrCreateIdentification(),
     findNestedChildOrCreate('gmd:citation', 'gmd:CI_Citation'),
-    fallback(
-      updateCitationDate(record.resourceUpdated, 'revision'),
-      appendCitationDate(record.resourceUpdated, 'revision')
+    appendChildren(
+      pipe(
+        createElement('gmd:date'),
+        createChild('gmd:CI_Date'),
+        appendChildren(
+          pipe(createElement('gmd:date'), writeDateTime(date)),
+          pipe(
+            createElement('gmd:dateType'),
+            createChild('gmd:CI_DateTypeCode'),
+            addAttribute(
+              'codeList',
+              'http://standards.iso.org/iso/19139/resources/gmxCodelists.xml#CI_DateTypeCode'
+            ),
+            addAttribute('codeListValue', type)
+          )
+        )
+      )
     )
-  )(rootEl)
+  )
+}
+
+export function writeResourceCreated(
+  record: DatasetRecord,
+  rootEl: XmlElement
+) {
+  removeResourceDate('creation')(rootEl)
+  if (!record.resourceCreated) return
+  appendResourceDate(record.resourceCreated, 'creation')(rootEl)
+}
+
+export function writeResourceUpdated(
+  record: DatasetRecord,
+  rootEl: XmlElement
+) {
+  removeResourceDate('revision')(rootEl)
+  if (!record.resourceUpdated) return
+  appendResourceDate(record.resourceUpdated, 'revision')(rootEl)
 }
 
 export function writeResourcePublished(
   record: DatasetRecord,
   rootEl: XmlElement
 ) {
-  if (!('resourcePublished' in record)) return
-  pipe(
-    findOrCreateIdentification(),
-    findNestedChildOrCreate('gmd:citation', 'gmd:CI_Citation'),
-    fallback(
-      updateCitationDate(record.resourcePublished, 'publication'),
-      appendCitationDate(record.resourcePublished, 'publication')
-    )
-  )(rootEl)
+  removeResourceDate('publication')(rootEl)
+  if (!record.resourcePublished) return
+  appendResourceDate(record.resourcePublished, 'publication')(rootEl)
 }
 
 export function writeSpatialRepresentation(
@@ -1022,20 +999,6 @@ export function writeGraphicOverviews(
   )(rootEl)
 }
 
-export function writeDistributions(record: DatasetRecord, rootEl: XmlElement) {
-  pipe(
-    removeDistributions(),
-    appendChildren(
-      ...record.distributions.map((d) =>
-        pipe(
-          createDistributionInfo(),
-          appendDistribution(d, appendDistributionFormat)
-        )
-      )
-    )
-  )(rootEl)
-}
-
 export function writeLineage(record: DatasetRecord, rootEl: XmlElement) {
   pipe(
     findNestedChildOrCreate(
@@ -1117,16 +1080,40 @@ export function createOnlineResource(onlineResource: ServiceOnlineResource) {
   )
 }
 
-export function writeOnlineResources(
-  record: ServiceRecord,
+export function appendDatasetOnlineResources(
+  record: DatasetRecord,
   rootEl: XmlElement
 ) {
-  pipe(
-    removeDistributions(),
-    appendChildren(...record.onlineResources.map(createOnlineResource))
+  appendChildren(
+    ...record.onlineResources.map((d) =>
+      pipe(
+        createDistributionInfo(),
+        appendOnlineResource(d, appendOnlineResourceFormat)
+      )
+    )
   )(rootEl)
 }
 
+export function appendServiceOnlineResources(
+  record: ServiceRecord,
+  rootEl: XmlElement
+) {
+  appendChildren(...record.onlineResources.map(createOnlineResource))(rootEl)
+}
+
+export function writeOnlineResources(
+  record: CatalogRecord,
+  rootEl: XmlElement
+) {
+  removeOnlineResources()(rootEl)
+
+  if (record.kind === 'dataset') {
+    appendDatasetOnlineResources(record, rootEl)
+    return
+  }
+  appendServiceOnlineResources(record, rootEl)
+}
+
 export function writeTemporalExtents(
   record: DatasetRecord,
   rootEl: XmlElement
@@ -1184,3 +1171,62 @@ export function writeTemporalExtents(
     )
   )(rootEl)
 }
+
+export function writeSpatialExtents(record: DatasetRecord, rootEl: XmlElement) {
+  const appendBoundingPolygon = (geometry?: Geometry) => {
+    if (!geometry) return null
+    return pipe(
+      createElement('gmd:EX_BoundingPolygon'),
+      appendChildren(
+        pipe(
+          createElement('gmd:polygon'),
+          appendChildren(() => writeGeometry(geometry))
+        )
+      )
+    )
+  }
+
+  const appendGeographicBoundingBox = (
+    bbox?: [number, number, number, number]
+  ) => {
+    if (!bbox) return null
+    return pipe(
+      createElement('gmd:EX_GeographicBoundingBox'),
+      appendChildren(
+        pipe(createElement('gmd:westBoundLongitude'), writeDecimal(bbox[0])),
+        pipe(createElement('gmd:eastBoundLongitude'), writeDecimal(bbox[2])),
+        pipe(createElement('gmd:southBoundLatitude'), writeDecimal(bbox[1])),
+        pipe(createElement('gmd:northBoundLatitude'), writeDecimal(bbox[3]))
+      )
+    )
+  }
+
+  const appendGeographicDescription = (description?: string) => {
+    if (!description) return null
+    return pipe(
+      createElement('gmd:EX_GeographicDescription'),
+      createChild('gmd:geographicIdentifier'),
+      createChild('gmd:MD_Identifier'),
+      createChild('gmd:code'),
+      writeCharacterString(description)
+    )
+  }
+
+  pipe(
+    findOrCreateIdentification(),
+    findNestedChildOrCreate('gmd:extent', 'gmd:EX_Extent'),
+    removeChildrenByName('gmd:geographicElement'),
+    appendChildren(
+      ...record.spatialExtents.map((extent) =>
+        pipe(
+          createElement('gmd:geographicElement'),
+          appendChildren(
+            appendBoundingPolygon(extent.geometry),
+            appendGeographicBoundingBox(extent.bbox),
+            appendGeographicDescription(extent.description)
+          )
+        )
+      )
+    )
+  )(rootEl)
+}

package/src/libs/api/metadata-converter/src/lib/xml-utils.ts

@@ -6,6 +6,7 @@ import {
   XmlText,
 } from '@rgrove/parse-xml'
 import { ChainableFunction, fallback } from './function-utils'
+
 export { XmlDocument, XmlElement } from '@rgrove/parse-xml'
 
 export class XmlParseError extends Error {
@@ -35,7 +36,8 @@ export function createDocument(rootEl: XmlElement): XmlDocument {
     if (namespace === 'xmlns' || namespace === null) return
     if (rootEl.attributes[`xmlns:${namespace}`]) return
     if (!NAMESPACES[namespace]) {
-      throw new Error(`No known URI for namespace ${namespace}`)
+      // the namespace is unknown but it might still be declared correctly: ignore it
+      return
     }
     rootEl.attributes[`xmlns:${namespace}`] = NAMESPACES[namespace]
   }
@@ -115,6 +117,10 @@ export function allChildrenElement(element: XmlElement): Array<XmlElement> {
   ] as Array<XmlElement>
 }
 
+export function firstChildElement(element: XmlElement): XmlElement {
+  return allChildrenElement(element)[0] ?? null
+}
+
 /**
  * Will return all matching elements nested according to the given
  * names (similar to a path), starting form the input element;
@@ -175,11 +181,11 @@ export function findParent(
 
 export function readText(): ChainableFunction<XmlElement, string> {
   return (el) => {
-    const textNode =
-      el && Array.isArray(el.children)
-        ? (el.children.find((node) => node.type === 'text') as XmlText)
-        : null
-    return textNode ? textNode.text : null
+    if (!el) return null
+    const textNode = Array.isArray(el.children)
+      ? (el.children.find((node) => node.type === 'text') as XmlText)
+      : null
+    return textNode ? textNode.text : ''
   }
 }
 
@@ -228,6 +234,7 @@ export function xmlToString(
 ${padding}<${el.name}${attrs}/>
 ${parentPadding}`
   }
+
   return `
 ${padding}<${el.name}${attrs}>${children}</${el.name}>
 ${parentPadding}`
@@ -242,7 +249,7 @@ function extractNamespace(name: string): string | null {
   return colon > -1 ? name.substring(0, colon) : null
 }
 
-const NAMESPACES = {
+export const NAMESPACES = {
   gmd: 'http://www.isotc211.org/2005/gmd',
   gco: 'http://www.isotc211.org/2005/gco',
   gfc: 'http://www.isotc211.org/2005/gfc',
@@ -277,6 +284,22 @@ const NAMESPACES = {
   cat: 'http://standards.iso.org/iso/19115/-3/cat/1.0',
   lan: 'http://standards.iso.org/iso/19115/-3/lan/1.0',
   mrc: 'http://standards.iso.org/iso/19115/-3/mrc/2.0',
+  rdf: 'http://www.w3.org/1999/02/22-rdf-syntax-ns#',
+  rdfs: 'http://www.w3.org/2000/01/rdf-schema#',
+  foaf: 'http://xmlns.com/foaf/0.1/',
+  xsd: 'http://www.w3.org/2001/XMLSchema#',
+  dcat: 'http://www.w3.org/ns/dcat#',
+  dct: 'http://purl.org/dc/terms/',
+  skos: 'http://www.w3.org/2004/02/skos/core#',
+  schema_org: 'http://schema.org/',
+  spdx: 'https://spdx.org/rdf/terms/#',
+  adms: 'http://www.w3.org/ns/adms#',
+  dqv: 'http://www.w3.org/ns/dqv#',
+  owl: 'http://www.w3.org/2002/07/owl#',
+  vcard: 'http://www.w3.org/2006/vcard/ns#',
+  time: 'http://www.w3.org/2006/time#',
+  locn: 'http://www.w3.org/ns/locn#',
+  mdcat: 'https://data.vlaanderen.be/ns/metadata-dcat#',
 }
 
 /**
@@ -307,11 +330,13 @@ function getTreeRoot(element: XmlElement): XmlElement {
 
 // stays on the parent element
 // if the given elements are part of a subtree, will add the root of subtree
+// will filter out falsy elements
 export function appendChildren(
   ...childrenFns: Array<ChainableFunction<void, XmlElement>>
 ): ChainableFunction<XmlElement, XmlElement> {
   return (element) => {
     if (!element) return null
+    childrenFns = childrenFns.filter((fn) => fn)
     element.children.push(...childrenFns.map((fn) => fn()).map(getTreeRoot))
     element.children.forEach((el) => (el.parent = element))
     return element
@@ -448,3 +473,21 @@ export function renameElements(
   doReplace(rootElement)
   return rootElement
 }
+
+/**
+ * This function use the DOMParser to check if the given xmlString is a valid XML file or throw an error
+ * (Generated by chatGPT)
+ * @param xmlString
+ */
+export function assertValidXml(xmlString: string): Document {
+  const parser = new DOMParser()
+  const xmlDoc = parser.parseFromString(xmlString, 'application/xml')
+  const parserError = xmlDoc.querySelector('parsererror')
+
+  if (parserError) {
+    console.error(parserError)
+    throw new Error('File is not a valid XML.')
+  }
+
+  return xmlDoc
+}