Merge branch 'develop' of https://github.com/IQSS/dataverse-frontend …

…into feature/229-basic-home-page-with-the-list-of-datasets
IQSS · Dec 19, 2023 · 99e16d3 · 99e16d3
2 parents ff238ce + 48c2521
commit 99e16d3
Show file tree

Hide file tree

Showing 45 changed files with 1,119 additions and 279 deletions.
diff --git a/README.md b/README.md
@@ -7,6 +7,7 @@
 ## Demo videos
 
 - 2023-08-01: [View mode of the dataset page](https://groups.google.com/g/dataverse-community/c/cxZ3Bal_-uo/m/h3kh3iVNCwAJ)
+- 2023-12-13: [Files table on the dataset page](https://groups.google.com/g/dataverse-community/c/w_rEMddESYc/m/6F7QC1p-AgAJ)
 
 ## Getting Started
 

diff --git a/...ign-system/src/lib/components/dropdown-button/dropdown-button-item/DropdownButtonItem.tsx b/...ign-system/src/lib/components/dropdown-button/dropdown-button-item/DropdownButtonItem.tsx
@@ -5,18 +5,25 @@ interface DropdownItemProps extends React.HTMLAttributes<HTMLElement> {
   href?: string
   eventKey?: string
   disabled?: boolean
+  download?: string
   children: ReactNode
 }
 
 export function DropdownButtonItem({
   href,
   eventKey,
   disabled,
+  download,
   children,
   ...props
 }: DropdownItemProps) {
   return (
-    <DropdownBS.Item href={href} eventKey={eventKey} disabled={disabled} {...props}>
+    <DropdownBS.Item
+      href={href}
+      eventKey={eventKey}
+      disabled={disabled}
+      download={download}
+      {...props}>
       {children}
     </DropdownBS.Item>
   )

diff --git a/public/locales/en/dataset.json b/public/locales/en/dataset.json
@@ -53,7 +53,13 @@
       }
     },
     "accessDataset": {
-      "title": "Access Dataset"
+      "title": "Access Dataset",
+      "downloadOptions": {
+        "header": "Download Options",
+        "zip": "Download ZIP",
+        "originalZip": "Original Format ZIP",
+        "archivalZip": "Archival Format (.tab) ZIP"
+      }
     },
     "uploadFiles": "Upload Files"
   },

diff --git a/src/dataset/domain/models/Dataset.ts b/src/dataset/domain/models/Dataset.ts
@@ -1,4 +1,5 @@
 import { Alert, AlertMessageKey } from '../../../alert/domain/models/Alert'
+import { FileDownloadSize } from '../../../files/domain/models/File'
 
 export enum DatasetLabelSemanticMeaning {
   DATASET = 'dataset',
@@ -263,6 +264,11 @@ export interface PrivateUrl {
   urlSnippet: string
 }
 
+export interface DatasetDownloadUrls {
+  original: string
+  archival: string
+}
+
 export class Dataset {
   constructor(
     public readonly persistentId: string,
@@ -276,8 +282,11 @@ export class Dataset {
     public readonly permissions: DatasetPermissions,
     public readonly locks: DatasetLock[],
     public readonly hasValidTermsOfAccess: boolean,
+    public readonly hasOneTabularFileAtLeast: boolean,
     public readonly isValid: boolean,
     public readonly isReleased: boolean,
+    public readonly downloadUrls: DatasetDownloadUrls,
+    public readonly fileDownloadSizes: FileDownloadSize[],
     public readonly thumbnail?: string,
     public readonly privateUrl?: PrivateUrl
   ) {}
@@ -359,8 +368,11 @@ export class Dataset {
       public readonly permissions: DatasetPermissions,
       public readonly locks: DatasetLock[],
       public readonly hasValidTermsOfAccess: boolean,
+      public readonly hasOneTabularFileAtLeast: boolean,
       public readonly isValid: boolean,
       public readonly isReleased: boolean,
+      public readonly downloadUrls: DatasetDownloadUrls,
+      public readonly fileDownloadSizes: FileDownloadSize[],
       public readonly thumbnail?: string,
       public readonly privateUrl?: PrivateUrl
     ) {
@@ -467,8 +479,11 @@ export class Dataset {
         this.permissions,
         this.locks,
         this.hasValidTermsOfAccess,
+        this.hasOneTabularFileAtLeast,
         this.isValid,
         this.isReleased,
+        this.downloadUrls,
+        this.fileDownloadSizes,
         this.thumbnail,
         this.privateUrl
       )

diff --git a/src/dataset/infrastructure/mappers/JSDatasetMapper.ts b/src/dataset/infrastructure/mappers/JSDatasetMapper.ts
@@ -1,26 +1,28 @@
 import {
   Dataset as JSDataset,
+  DatasetLock as JSDatasetLock,
   DatasetMetadataBlock as JSDatasetMetadataBlock,
   DatasetMetadataBlocks as JSDatasetMetadataBlocks,
   DatasetMetadataFields as JSDatasetMetadataFields,
-  DatasetVersionInfo as JSDatasetVersionInfo,
   DatasetUserPermissions as JSDatasetPermissions,
-  DatasetLock as JSDatasetLock
+  DatasetVersionInfo as JSDatasetVersionInfo
 } from '@iqss/dataverse-client-javascript'
 import { DatasetVersionState as JSDatasetVersionState } from '@iqss/dataverse-client-javascript/dist/datasets/domain/models/Dataset'
 import {
   Dataset,
-  DatasetPublishingStatus,
+  DatasetDownloadUrls,
+  DatasetLock,
+  DatasetLockReason,
   DatasetMetadataBlock,
   DatasetMetadataBlocks,
   DatasetMetadataFields,
+  DatasetPermissions,
+  DatasetPublishingStatus,
   DatasetVersion,
   MetadataBlockName,
-  DatasetPermissions,
-  DatasetLock,
-  DatasetLockReason,
   PrivateUrl
 } from '../../domain/models/Dataset'
+import { FileDownloadMode, FileDownloadSize, FileSizeUnit } from '../../../files/domain/models/File'
 
 export class JSDatasetMapper {
   static toDataset(
@@ -29,12 +31,19 @@ export class JSDatasetMapper {
     summaryFieldsNames: string[],
     jsDatasetPermissions: JSDatasetPermissions,
     jsDatasetLocks: JSDatasetLock[],
+    jsDatasetFilesTotalOriginalDownloadSize: number,
+    jsDatasetFilesTotalArchivalDownloadSize: number,
     requestedVersion?: string,
     privateUrl?: PrivateUrl
   ): Dataset {
+    const version = JSDatasetMapper.toVersion(
+      jsDataset.versionId,
+      jsDataset.versionInfo,
+      requestedVersion
+    )
     return new Dataset.Builder(
       jsDataset.persistentId,
-      JSDatasetMapper.toVersion(jsDataset.versionId, jsDataset.versionInfo, requestedVersion),
+      version,
       citation,
       JSDatasetMapper.toSummaryFields(jsDataset.metadataBlocks, summaryFieldsNames),
       jsDataset.license,
@@ -47,8 +56,14 @@ export class JSDatasetMapper {
       JSDatasetMapper.toDatasetPermissions(jsDatasetPermissions),
       JSDatasetMapper.toLocks(jsDatasetLocks),
       true, // TODO Connect with dataset hasValidTermsOfAccess
+      true, // TODO Connect with dataset hasOneTabularFileAtLeast
       true, // TODO Connect with dataset isValid
       JSDatasetMapper.toIsReleased(jsDataset.versionInfo),
+      JSDatasetMapper.toDownloadUrls(jsDataset.persistentId, version),
+      JSDatasetMapper.toFileDownloadSizes(
+        jsDatasetFilesTotalOriginalDownloadSize,
+        jsDatasetFilesTotalArchivalDownloadSize
+      ),
       undefined, // TODO: get dataset thumbnail from Dataverse https://github.com/IQSS/dataverse-frontend/issues/203
       privateUrl
     ).build()
@@ -210,4 +225,32 @@ export class JSDatasetMapper {
       }
     })
   }
+
+  static toDownloadUrls(
+    jsDatasetPersistentId: string,
+    version: DatasetVersion
+  ): DatasetDownloadUrls {
+    return {
+      original: `/api/access/dataset/:persistentId/versions/${version.toString()}?persistentId=${jsDatasetPersistentId}&format=original`,
+      archival: `/api/access/dataset/:persistentId/versions/${version.toString()}?persistentId=${jsDatasetPersistentId}`
+    }
+  }
+
+  static toFileDownloadSizes(
+    jsDatasetFilesTotalOriginalDownloadSize: number,
+    jsDatasetFilesTotalArchivalDownloadSize: number
+  ): FileDownloadSize[] {
+    return [
+      new FileDownloadSize(
+        jsDatasetFilesTotalOriginalDownloadSize,
+        FileSizeUnit.BYTES,
+        FileDownloadMode.ORIGINAL
+      ),
+      new FileDownloadSize(
+        jsDatasetFilesTotalArchivalDownloadSize,
+        FileSizeUnit.BYTES,
+        FileDownloadMode.ARCHIVAL
+      )
+    ]
+  }
 }
diff --git a/src/dataset/infrastructure/repositories/DatasetJSDataverseRepository.ts b/src/dataset/infrastructure/repositories/DatasetJSDataverseRepository.ts
@@ -11,7 +11,9 @@ import {
   getDatasetUserPermissions,
   ReadError,
   getDatasetLocks,
-  DatasetLock as JSDatasetLock
+  DatasetLock as JSDatasetLock,
+  getDatasetFilesTotalDownloadSize,
+  FileDownloadSizeMode
 } from '@iqss/dataverse-client-javascript'
 import { JSDatasetMapper } from '../mappers/JSDatasetMapper'
 import { TotalDatasetsCount } from '../../domain/models/TotalDatasetsCount'
@@ -20,7 +22,6 @@ import { DatasetPreview } from '../../domain/models/DatasetPreview'
 import { DatasetPreviewMother } from '../../../../tests/component/dataset/domain/models/DatasetPreviewMother'
 
 const includeDeaccessioned = true
-
 export class DatasetJSDataverseRepository implements DatasetRepository {
   // eslint-disable-next-line unused-imports/no-unused-vars
   getAll(paginationInfo: DatasetPaginationInfo): Promise<DatasetPreview[]> {
@@ -54,23 +55,41 @@ export class DatasetJSDataverseRepository implements DatasetRepository {
           getDatasetSummaryFieldNames.execute(),
           getDatasetCitation.execute(jsDataset.id, this.versionToVersionId(version)),
           getDatasetUserPermissions.execute(jsDataset.id),
-          getDatasetLocks.execute(jsDataset.id)
+          getDatasetLocks.execute(jsDataset.id),
+          getDatasetFilesTotalDownloadSize.execute(
+            persistentId,
+            this.versionToVersionId(version),
+            FileDownloadSizeMode.ORIGINAL,
+            undefined,
+            includeDeaccessioned
+          ),
+          getDatasetFilesTotalDownloadSize.execute(
+            persistentId,
+            this.versionToVersionId(version),
+            FileDownloadSizeMode.ARCHIVAL,
+            undefined,
+            includeDeaccessioned
+          )
         ])
       )
       .then(
-        ([jsDataset, summaryFieldsNames, citation, jsDatasetPermissions, jsDatasetLocks]: [
-          JSDataset,
-          string[],
-          string,
-          JSDatasetPermissions,
-          JSDatasetLock[]
-        ]) =>
+        ([
+          jsDataset,
+          summaryFieldsNames,
+          citation,
+          jsDatasetPermissions,
+          jsDatasetLocks,
+          jsDatasetFilesTotalOriginalDownloadSize,
+          jsDatasetFilesTotalArchivalDownloadSize
+        ]: [JSDataset, string[], string, JSDatasetPermissions, JSDatasetLock[], number, number]) =>
           JSDatasetMapper.toDataset(
             jsDataset,
             citation,
             summaryFieldsNames,
             jsDatasetPermissions,
             jsDatasetLocks,
+            jsDatasetFilesTotalOriginalDownloadSize,
+            jsDatasetFilesTotalArchivalDownloadSize,
             requestedVersion
           )
       )
@@ -99,10 +118,12 @@ export class DatasetJSDataverseRepository implements DatasetRepository {
             canManageDatasetPermissions: true,
             canDeleteDatasetDraft: true,
             canViewUnpublishedDataset: true
-          },
-          []
+          }, // TODO Connect with JS dataset permissions for privateUrl when it is available in js-dataverse
+          [], // TODO Connect with JS dataset locks for privateUrl when it is available in js-dataverse
+          0, // TODO Connect with JS dataset filesTotalDownloadSize for privateUrl when it is available in js-dataverse
+          0 // TODO Connect with JS dataset filesTotalDownloadSize for privateUrl when it is available in js-dataverse
         )
-      ) // TODO Connect with JS dataset permissions and getDatasetLocks.execute(privateUrlToken) when it is available in js-dataverse
+      )
       .catch((error: ReadError) => {
         throw new Error(error.message)
       })

diff --git a/src/files/domain/models/File.ts b/src/files/domain/models/File.ts
@@ -20,7 +20,7 @@ export class FileSize {
   }
 
   constructor(readonly value: number, readonly unit: FileSizeUnit) {
-    ;[this.value, this.unit] = this.convertToLargestUnit(value, unit)
+    ;[this.value, this.unit] = FileSize.convertToLargestUnit(value, unit)
   }
 
   toString(): string {
@@ -33,7 +33,7 @@ export class FileSize {
     return this.value * FileSize.multiplier[this.unit]
   }
 
-  private convertToLargestUnit(value: number, unit: FileSizeUnit): [number, FileSizeUnit] {
+  static convertToLargestUnit(value: number, unit: FileSizeUnit): [number, FileSizeUnit] {
     let convertedValue = value
     let convertedUnit = unit
 
@@ -45,7 +45,7 @@ export class FileSize {
     return [convertedValue, convertedUnit]
   }
 
-  private getNextUnit(unit: FileSizeUnit): FileSizeUnit {
+  static getNextUnit(unit: FileSizeUnit): FileSizeUnit {
     switch (unit) {
       case FileSizeUnit.BYTES:
         return FileSizeUnit.KILOBYTES
@@ -63,6 +63,22 @@ export class FileSize {
   }
 }
 
+export enum FileDownloadMode {
+  ORIGINAL = 'original',
+  ARCHIVAL = 'archival'
+}
+
+export class FileDownloadSize extends FileSize {
+  constructor(
+    readonly value: number,
+    readonly unit: FileSizeUnit,
+    readonly mode: FileDownloadMode
+  ) {
+    super(value, unit)
+    ;[this.value, this.unit] = FileDownloadSize.convertToLargestUnit(value, unit)
+  }
+}
+
 export interface FileAccess {
   restricted: boolean
   latestVersionRestricted: boolean
@@ -115,6 +131,7 @@ export enum FileLabelType {
   CATEGORY = 'category',
   TAG = 'tag'
 }
+
 export interface FileLabel {
   type: FileLabelType
   value: string
@@ -145,6 +162,12 @@ export interface FileIngest {
   reportMessage?: string
 }
 
+export interface FileDownloadUrls {
+  original: string
+  tabular?: string
+  rData?: string
+}
+
 export class File {
   constructor(
     readonly id: number,
@@ -158,12 +181,13 @@ export class File {
     readonly labels: FileLabel[],
     public readonly isDeleted: boolean,
     public readonly ingest: FileIngest,
-    readonly checksum?: FileChecksum,
-    readonly thumbnail?: string,
+    public readonly downloadUrls: FileDownloadUrls,
+    public thumbnail?: string,
     readonly directory?: string,
     readonly embargo?: FileEmbargo,
     readonly tabularData?: FileTabularData,
-    readonly description?: string
+    readonly description?: string,
+    readonly checksum?: FileChecksum
   ) {}
 
   getLink(): string {

diff --git a/src/files/domain/models/FileCriteria.ts b/src/files/domain/models/FileCriteria.ts
@@ -62,6 +62,15 @@ export class FileCriteria {
       searchText
     )
   }
+
+  get someFilterApplied(): boolean {
+    return (
+      this.filterByType !== undefined ||
+      this.filterByAccess !== undefined ||
+      this.filterByTag !== undefined ||
+      this.searchText !== undefined
+    )
+  }
 }
 
 export enum FileSortByOption {