GetFile.ts

import { IFilesRepository } from '../repositories/IFilesRepository'
import { FileModel } from '../models/FileModel'
import { DatasetNotNumberedVersion } from '../../../datasets'
import { UseCase } from '../../../core/domain/useCases/UseCase'

export class GetFile implements UseCase<FileModel> {
  constructor(private readonly filesRepository: IFilesRepository) {}

  /**
   * Returns a FileModel instance, given the search parameters to identify it.
   *
   * @param {number | string} [fileId] - The File identifier, which can be a string (for persistent identifiers), or a number (for numeric identifiers).
   * @param {string | DatasetNotNumberedVersion} [datasetVersionId=DatasetNotNumberedVersion.LATEST] - The dataset version identifier, which can be a version-specific numeric string (for example, 1.0) or a DatasetNotNumberedVersion enum value. If this parameter is not set, the default value is: DatasetNotNumberedVersion.LATEST
   * @param {boolean} [includeDeaccessioned=false] - If true, the file will be returned even if it has been deaccessioned.
   * @returns {Promise<FileModel>}
   */
  async execute(
    fileId: number | string,
    datasetVersionId: string | DatasetNotNumberedVersion = DatasetNotNumberedVersion.LATEST,
    includeDeaccessioned = false
  ): Promise<FileModel> {
    return (await this.filesRepository.getFile(
      fileId,
      datasetVersionId,
      false,
      includeDeaccessioned
    )) as FileModel
  }
}