Merge pull request #608 from IQSS/feat/599-get-collection-description-html

Collection Page: convert html to markdown in description field

Author: ofahimIQSS

package-lock.json

@@ -17,7 +17,7 @@
     "@dnd-kit/sortable": "8.0.0",
     "@dnd-kit/utilities": "3.2.2",
     "@faker-js/faker": "7.6.0",
-    "@iqss/dataverse-client-javascript": "2.0.0-alpha.20",
+    "@iqss/dataverse-client-javascript": "2.0.0-alpha.24",
     "@iqss/dataverse-design-system": "*",
     "@istanbuljs/nyc-config-typescript": "1.0.2",
     "@tanstack/react-table": "8.9.2",

package.json

@@ -1,4 +1,5 @@
 import { Collection } from '../../collection/domain/models/Collection'
+import TurndownService from 'turndown'
 import styles from './Collection.module.scss'
 import { MarkdownComponent } from '../dataset/markdown/MarkdownComponent'
 import { Badge } from '@iqss/dataverse-design-system'
@@ -7,6 +8,7 @@ import { DatasetLabelSemanticMeaning } from '../../dataset/domain/models/Dataset
 interface CollectionInfoProps {
   collection: Collection
 }
+const turndownService = new TurndownService()
 
 export function CollectionInfo({ collection }: CollectionInfoProps) {
   return (
@@ -26,7 +28,7 @@ export function CollectionInfo({ collection }: CollectionInfoProps) {
       </header>
       {collection.description && (
         <div>
-          <MarkdownComponent markdown={collection.description} />
+          <MarkdownComponent markdown={turndownService.turndown(collection.description)} />
         </div>
       )}
     </>

src/sections/collection/CollectionInfo.tsx

@@ -7,14 +7,15 @@ describe('CollectionInfo', () => {
       name: 'Collection Name',
       affiliation: 'Affiliation',
       isReleased: true,
-      description: 'Here is a description with [a link](https://dataverse.org)'
+      description: 'Here is a <b>description</b> with <a href="https://dataverse.org">a link</a>'
     })
     cy.customMount(<CollectionInfo collection={collection} />)
 
     cy.findByRole('heading', { name: 'Collection Name' }).should('exist')
     cy.findByText('(Affiliation)').should('exist')
-    cy.findByText(/Here is a description with/).should('exist')
+    cy.findByText(/Here is a/).should('exist')
     cy.findByRole('link', { name: 'a link' }).should('exist')
+    cy.get('strong').contains('description').should('exist')
     cy.findByText('Unpublished').should('not.exist')
   })
 

tests/component/sections/collection/CollectionInfo.spec.tsx

@@ -481,10 +481,10 @@ describe('File JSDataverse Repository', () => {
           dataset.persistentId,
           dataset.version,
           new FilePaginationInfo(),
-          new FileCriteria().withFilterByType('text/tab-separated-values')
+          new FileCriteria().withFilterByType('text/plain')
         )
         .then((files) => {
-          expect(files.length).to.equal(1)
+          expect(files.length).to.equal(2)
         })
     })