resolve merge conflicts

Author: ekraffmiller

docs/useCases.md

@@ -52,6 +52,8 @@ The different use cases currently available in the package are classified below,
     - [Get the size of Downloading all the files of a Dataset Version](#get-the-size-of-downloading-all-the-files-of-a-dataset-version)
     - [Get User Permissions on a File](#get-user-permissions-on-a-file)
     - [List Files in a Dataset](#list-files-in-a-dataset)
+    - [Is File Deleted](#is-file-deleted)
+    - [Get File Version Summaries](#get-file-version-summaries)
   - [Files write use cases](#files-write-use-cases)
     - [File Uploading Use Cases](#file-uploading-use-cases)
     - [Delete a File](#delete-a-file)
@@ -1571,6 +1573,52 @@ If restrict is false then enableAccessRequest and termsOfAccess are ignored
 If restrict is true and enableAccessRequest is false then termsOfAccess is required.
 The enableAccessRequest and termsOfAccess are applied to the Draft version of the Dataset and affect all of the restricted files in said Draft version.
 
+#### Is File Deleted
+
+Check if the file has been deleted, return a boolean.
+
+##### Example call:
+
+```typescript
+import { isFileDeleted } from '@iqss/dataverse-client-javascript'
+
+/* ... */
+
+const fileId = 12345
+
+await isFileDeleted.execute(fileId).then((isDeleted: boolean) => {
+  /* ... */
+})
+
+/* ... */
+```
+
+_See [use case](../src/files/domain/useCases/isFileDeleted.ts) implementation_.
+
+The `fileId` parameter can be a string, for persistent identifiers, or a number, for numeric identifiers.
+
+#### Get File Version Summaries
+
+Get the file versions summaries, return a list of summaries for each version
+
+##### Example call:
+
+```typescript
+import { getFileVersionSummaries } from '@iqss/dataverse-client-javascript'
+
+/* ... */
+
+const fileId = 1
+
+getFileVersionSummaries.execute(fileId).then((fileVersionSummaries: fileVersionSummaryInfo[]) => {
+  /* ... */
+})
+
+/* ... */
+```
+
+_See [use case](../src/files/domain/useCases/GetFileVersionSummaries.ts) implementation_.
+
 ## Metadata Blocks
 
 ### Metadata Blocks read use cases

src/collections/domain/models/CollectionSearchCriteria.ts

@@ -2,7 +2,8 @@ import { CollectionItemType } from './CollectionItemType'
 
 export enum SortType {
   NAME = 'name',
-  DATE = 'date'
+  DATE = 'date',
+  SCORE = 'score'
 }
 
 export enum OrderType {

src/collections/infra/repositories/CollectionsRepository.ts

@@ -222,10 +222,7 @@ export class CollectionsRepository extends ApiRepository implements ICollections
     }
 
     if (searchText) {
-      queryParams.set(
-        GetMyDataCollectionItemsQueryParams.SEARCH_TEXT,
-        encodeURIComponent(searchText)
-      )
+      queryParams.set(GetMyDataCollectionItemsQueryParams.SEARCH_TEXT, searchText)
     }
 
     roleIds.forEach((roleId) => {
@@ -316,10 +313,7 @@ export class CollectionsRepository extends ApiRepository implements ICollections
     collectionSearchCriteria: CollectionSearchCriteria
   ) {
     if (collectionSearchCriteria.searchText) {
-      queryParams.set(
-        GetCollectionItemsQueryParams.QUERY,
-        encodeURIComponent(collectionSearchCriteria.searchText)
-      )
+      queryParams.set(GetCollectionItemsQueryParams.QUERY, collectionSearchCriteria.searchText)
     }
 
     if (collectionSearchCriteria?.itemTypes) {

src/files/domain/models/FileVersionSummaryInfo.ts

@@ -0,0 +1,27 @@
+import { DatasetVersionState } from '../../../datasets/domain/models/Dataset'
+
+export interface FileVersionSummaryInfo {
+  datasetVersion: string
+  contributors?: string
+  publishedDate?: string
+  fileDifferenceSummary?: FileDifferenceSummary
+  versionState?: DatasetVersionState
+  datafileId: number
+  persistentId?: string
+  versionNote?: string
+}
+
+export type FileDifferenceSummary = {
+  file?: FileChangeType
+  fileAccess?: 'Restricted' | 'Unrestricted'
+  fileMetadata?: FileMetadataChange[]
+  deaccessionedReason?: string
+  fileTags?: { [key in FileChangeType]?: number }
+}
+
+export type FileChangeType = 'Added' | 'Deleted' | 'Replaced' | 'Changed'
+
+export interface FileMetadataChange {
+  name: string
+  action: FileChangeType
+}

src/files/domain/repositories/IFilesRepository.ts

@@ -10,6 +10,7 @@ import { FileUploadDestination } from '../models/FileUploadDestination'
 import { UploadedFileDTO } from '../dtos/UploadedFileDTO'
 import { UpdateFileMetadataDTO } from '../dtos/UpdateFileMetadataDTO'
 import { RestrictFileDTO } from '../dtos/RestrictFileDTO'
+import { FileVersionSummaryInfo } from '../models/FileVersionSummaryInfo'
 
 export interface IFilesRepository {
   getDatasetFiles(
@@ -84,4 +85,8 @@ export interface IFilesRepository {
     categories: string[],
     replace?: boolean
   ): Promise<void>
+
+  getFileVersionSummaries(fileId: number | string): Promise<FileVersionSummaryInfo[]>
+
+  isFileDeleted(fileId: number | string): Promise<boolean>
 }

src/files/domain/useCases/GetFileVersionSummaries.ts

@@ -0,0 +1,21 @@
+import { UseCase } from '../../../core/domain/useCases/UseCase'
+import { FileVersionSummaryInfo } from '../models/FileVersionSummaryInfo'
+import { IFilesRepository } from '../repositories/IFilesRepository'
+
+export class GetFileVersionSummaries implements UseCase<FileVersionSummaryInfo[]> {
+  private filesRepository: IFilesRepository
+
+  constructor(filesRepository: IFilesRepository) {
+    this.filesRepository = filesRepository
+  }
+
+  /**
+   * Returns a list of versions for a given file including a summary of differences between consecutive versions
+   *
+   * @param {number | string} [fileId] - The file identifier, which can be a string (for persistent identifiers), or a number (for numeric identifiers).
+   * @returns {Promise<FileVersionSummaryInfo[]>} - An array of FileVersionSummaryInfo.
+   */
+  async execute(fileId: number | string): Promise<FileVersionSummaryInfo[]> {
+    return await this.filesRepository.getFileVersionSummaries(fileId)
+  }
+}

src/files/domain/useCases/IsFileDeleted.ts

@@ -0,0 +1,16 @@
+import { IFilesRepository } from '../repositories/IFilesRepository'
+import { UseCase } from '../../../core/domain/useCases/UseCase'
+
+export class IsFileDeleted implements UseCase<boolean> {
+  constructor(private readonly filesRepository: IFilesRepository) {}
+
+  /**
+   * Returns a boolean, indicating whether the file has been deleted or not.
+   *
+   * @param {number | string} [fileId] - The File identifier, which can be a string (for persistent identifiers), or a number (for numeric identifiers).
+   * @returns {Promise<boolean>} - A boolean indicating whether the file has been deleted or not.
+   */
+  async execute(fileId: number | string): Promise<boolean> {
+    return await this.filesRepository.isFileDeleted(fileId)
+  }
+}

src/files/index.ts

@@ -17,6 +17,8 @@ import { RestrictFile } from './domain/useCases/RestrictFile'
 import { UpdateFileMetadata } from './domain/useCases/UpdateFileMetadata'
 import { UpdateFileTabularTags } from './domain/useCases/UpdateFileTabularTags'
 import { UpdateFileCategories } from './domain/useCases/UpdateFileCategories'
+import { GetFileVersionSummaries } from './domain/useCases/GetFileVersionSummaries'
+import { IsFileDeleted } from './domain/useCases/IsFileDeleted'
 
 const filesRepository = new FilesRepository()
 const directUploadClient = new DirectUploadClient(filesRepository)
@@ -38,6 +40,8 @@ const restrictFile = new RestrictFile(filesRepository)
 const updateFileMetadata = new UpdateFileMetadata(filesRepository)
 const updateFileTabularTags = new UpdateFileTabularTags(filesRepository)
 const updateFileCategories = new UpdateFileCategories(filesRepository)
+const getFileVersionSummaries = new GetFileVersionSummaries(filesRepository)
+const isFileDeleted = new IsFileDeleted(filesRepository)
 
 export {
   getDatasetFiles,
@@ -56,7 +60,9 @@ export {
   updateFileMetadata,
   updateFileTabularTags,
   updateFileCategories,
-  replaceFile
+  replaceFile,
+  getFileVersionSummaries,
+  isFileDeleted
 }
 
 export { FileModel as File, FileEmbargo, FileChecksum } from './domain/models/FileModel'

src/files/infra/repositories/FilesRepository.ts

@@ -22,6 +22,8 @@ import { UploadedFileDTO } from '../../domain/dtos/UploadedFileDTO'
 import { UpdateFileMetadataDTO } from '../../domain/dtos/UpdateFileMetadataDTO'
 import { ApiConstants } from '../../../core/infra/repositories/ApiConstants'
 import { RestrictFileDTO } from '../../domain/dtos/RestrictFileDTO'
+import { FileVersionSummaryInfo } from '../../domain/models/FileVersionSummaryInfo'
+import { transformFileVersionSummaryInfoResponseToFileVersionSummaryInfo } from './transformers/fileVersionSummaryInfoTransformers'
 
 export interface GetFilesQueryParams {
   includeDeaccessioned: boolean
@@ -415,4 +417,23 @@ export class FilesRepository extends ApiRepository implements IFilesRepository {
         throw error
       })
   }
+
+  public async getFileVersionSummaries(fileId: number | string): Promise<FileVersionSummaryInfo[]> {
+    return this.doGet(
+      this.buildApiEndpoint(this.filesResourceName, 'versionDifferences', fileId),
+      true
+    )
+      .then((response) => transformFileVersionSummaryInfoResponseToFileVersionSummaryInfo(response))
+      .catch((error) => {
+        throw error
+      })
+  }
+
+  public async isFileDeleted(fileId: number | string): Promise<boolean> {
+    return this.doGet(this.buildApiEndpoint(this.filesResourceName, 'hasBeenDeleted', fileId), true)
+      .then((response) => response.data.data)
+      .catch((error) => {
+        throw error
+      })
+  }
 }

src/files/infra/repositories/transformers/fileVersionSummaryInfoTransformers.ts

@@ -0,0 +1,57 @@
+import { AxiosResponse } from 'axios'
+import {
+  FileVersionSummaryInfo,
+  FileMetadataChange,
+  FileDifferenceSummary
+} from '../../../domain/models/FileVersionSummaryInfo'
+import { DatasetVersionState } from '../../../../datasets/domain/models/Dataset'
+
+export interface FileVersionSummaryInfoPayload {
+  datasetVersion: string
+  contributors?: string
+  publishedDate?: string
+  fileDifferenceSummary?: {
+    file?: string
+    FileAccess?: string
+    FileMetadata?: FileMetadataChange[]
+    deaccessionedReason?: string
+    FileTags?: {
+      Added?: number
+      Deleted?: number
+      Changed?: number
+    }
+  }
+  versionState?: DatasetVersionState
+  datafileId: number
+  persistentId?: string
+  versionNote?: string
+}
+
+export const transformFileVersionSummaryInfoResponseToFileVersionSummaryInfo = (
+  response: AxiosResponse
+): FileVersionSummaryInfo[] => {
+  const payload = response.data.data
+
+  return payload.map((item: FileVersionSummaryInfoPayload): FileVersionSummaryInfo => {
+    const summary = item.fileDifferenceSummary || {}
+
+    const fileDifferenceSummary: FileDifferenceSummary = {
+      ...(summary.file && { file: summary.file }),
+      ...(summary.FileAccess && { fileAccess: summary.FileAccess }),
+      ...(summary.FileMetadata && { fileMetadata: summary.FileMetadata }),
+      ...(summary.deaccessionedReason && { deaccessionedReason: summary.deaccessionedReason }),
+      ...(summary.FileTags && { fileTags: summary.FileTags })
+    } as FileDifferenceSummary
+
+    return {
+      datasetVersion: item.datasetVersion,
+      contributors: item.contributors,
+      publishedDate: item.publishedDate,
+      fileDifferenceSummary: fileDifferenceSummary,
+      versionState: item.versionState,
+      datafileId: item.datafileId,
+      persistentId: item.persistentId,
+      versionNote: item.versionNote
+    }
+  })
+}