DatasetRepository.ts

import { Dataset, DatasetLock } from '../models/Dataset'
import { DatasetVersionDiff } from '../models/DatasetVersionDiff'
import { DatasetPaginationInfo } from '../models/DatasetPaginationInfo'
import { DatasetDTO } from '../useCases/DTOs/DatasetDTO'
import { DatasetsWithCount } from '../models/DatasetsWithCount'
import { VersionUpdateType } from '../models/VersionUpdateType'
import { DatasetVersionSummaryInfo } from '../models/DatasetVersionSummaryInfo'
import { DatasetDeaccessionDTO } from '../useCases/DTOs/DatasetDTO'
import { DatasetDownloadCount } from '../models/DatasetDownloadCount'
import { FormattedCitation, CitationFormat } from '../models/DatasetCitation'
import { DatasetTemplate } from '../models/DatasetTemplate'
import { CollectionSummary } from '@/collection/domain/models/CollectionSummary'
import { DatasetType } from '../models/DatasetType'

export interface DatasetRepository {
  getByPersistentId: (
    persistentId: string,
    version?: string,
    requestedVersion?: string,
    keepRawFields?: boolean
  ) => Promise<Dataset | undefined>
  getLocks(persistentId: string): Promise<DatasetLock[]>
  getByPrivateUrlToken: (privateUrlToken: string) => Promise<Dataset | undefined>
  getVersionDiff: (
    persistentId: string,
    oldVersion: string,
    newVersion: string,
    includeDeaccessioned: boolean
  ) => Promise<DatasetVersionDiff>

  create: (
    dataset: DatasetDTO,
    collectionId: string,
    datasetType?: string
  ) => Promise<{ persistentId: string }>
  updateMetadata: (
    datasetId: string | number,
    datasetDTO: DatasetDTO,
    sourceLastUpdateTime?: string
  ) => Promise<void>
  deaccession: (
    datasetId: string | number,
    version: string,
    deaccessionDTO: DatasetDeaccessionDTO
  ) => Promise<void>

  getAllWithCount: (
    collectionId: string,
    paginationInfo: DatasetPaginationInfo
  ) => Promise<DatasetsWithCount>
  publish(persistentId: string, versionUpdateType: VersionUpdateType): Promise<void>
  getDatasetVersionsSummaries: (datasetId: number | string) => Promise<DatasetVersionSummaryInfo[]>
  getDownloadCount: (
    datasetId: string | number,
    includeMDC?: boolean
  ) => Promise<DatasetDownloadCount>
  deleteDatasetDraft: (datasetId: string | number) => Promise<void>
  getAvailableCategories: (datasetId: string | number) => Promise<string[]>
  getDatasetCitationInOtherFormats: (
    datasetId: string | number,
    version: string,
    format: CitationFormat
  ) => Promise<FormattedCitation>
  getTemplates: (collectionIdOrAlias: number | string) => Promise<DatasetTemplate[]>
  link(datasetId: string | number, collectionIdOrAlias: string | number): Promise<void>
  unlink(datasetId: string | number, collectionIdOrAlias: string | number): Promise<void>
  getDatasetLinkedCollections: (datasetId: string | number) => Promise<CollectionSummary[]>
  getAvailableDatasetTypes: () => Promise<DatasetType[]>
}